Run a Task — Rightbrain

Run a specified Task against provided text and/or image input. The response is controlled by the output_format of the Task. Note that a Task must be enabled to be run.

Path parameters

org_idstringRequired

The unique identifier of the organization.

project_idstringRequired

The unique identifier of the project.

task_idstringRequired

The specific Task to reference.

Query parameters

revisionstringOptional

Request

This endpoint expects a multipart form containing an optional file.

task_inputstringRequired

The data input to the Task. This should be relevant to the user_prompt and provide values for the dynamic {...} parameters that are referenced in the prompt. Not required if image_required is set to true and there are no dynamic parameters in the prompt. It should be send as a JSON string.

task_filefileOptional

Response

This endpoint returns an object.

task_idstring

The unique identifier of the Task associated with this run.

task_revision_idstring

The unique identifier of the Task Revision associated with this run.

responsemap from strings to any

The structured response from the Task execution.

run_datamap from strings to any

Additional data about the Task such as the submitted text input.

idstring

The unique identifier of the Task Run.

createddatetime

The timestamp when the Task Run was created.

input_tokensinteger

The number of tokens submit as input to the model.

output_tokensinteger

The number of tokens generated and output by the model.

total_tokensinteger

The total token usage for the TaskRun.

1 curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/task/task_id/run \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: multipart/form-data" \ 4 -F task_input="{\"description\": \"brown hair, blue sweater\"}" \ 5 -F task_file=@<file1>

1 { 2 "task_id": "019011e6-e530-3aca-6cf7-2973387c255d", 3 "task_revision_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1", 4 "response": { 5 "hint": "The image is not suitable for authentication and onboarding checks. Please ensure the photo is a clear, passport-style image with a plain background, good lighting, and no accessories like sunglasses.", 6 "match": false, 7 "rationale": "The image does not meet the requirements for a passport-style photo. The person is wearing sunglasses, and the background is not plain.", 8 "compliance": false 9 }, 10 "run_data": { 11 "submitted": { 12 "description": "brown hair, blue sweater" 13 } 14 }, 15 "id": "0190a234-cb74-6342-dec6-4be8f73f0c9f", 16 "created": "2024-07-11T14:31:21.989219", 17 "input_tokens": 295, 18 "output_tokens": 58, 19 "total_tokens": 353 20 }

1	curl -X POST https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/task/task_id/run \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: multipart/form-data" \
4	-F task_input="{\"description\": \"brown hair, blue sweater\"}" \
5	-F task_file=@<file1>

1	{
2	"task_id": "019011e6-e530-3aca-6cf7-2973387c255d",
3	"task_revision_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
4	"response": {
5	"hint": "The image is not suitable for authentication and onboarding checks. Please ensure the photo is a clear, passport-style image with a plain background, good lighting, and no accessories like sunglasses.",
6	"match": false,
7	"rationale": "The image does not meet the requirements for a passport-style photo. The person is wearing sunglasses, and the background is not plain.",
8	"compliance": false
9	},
10	"run_data": {
11	"submitted": {
12	"description": "brown hair, blue sweater"
13	}
14	},
15	"id": "0190a234-cb74-6342-dec6-4be8f73f0c9f",
16	"created": "2024-07-11T14:31:21.989219",
17	"input_tokens": 295,
18	"output_tokens": 58,
19	"total_tokens": 353
20	}