List Tasks

GET

List all Tasks in the project with pagination support.

Returns a paginated list of Tasks with their basic information:

Task ID and metadata
Active revision status
Latest modification time
Tags

Use the page_limit and cursor parameters to navigate through the results.

Path parameters

org_idstringRequired

The unique identifier of the organization.

project_idstringRequired

The unique identifier of the project.

Query parameters

namestringOptional

Filter tasks by name (case-insensitive partial match).

tag_idstringOptionalformat: "uuid"

Filter tasks by tag ID.

include_testsbooleanOptional

Include test revisions

cursorstringOptional

Pagination cursor for the next page of results.

page_limitintegerOptional>=1<=100Defaults to 100

Maximum number of tasks to return per page.

Response

Successful Response

resultslist of objects

The list of items returned for the current page.

paginationobjectOptional

Contains pagination information for the result set.

Errors

GET

1 curl https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/task \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "results": [
3     {
4       "name": "Fintech Pre-Triage",
5       "enabled": true,
6       "id": "019011e6-e530-3aca-6cf7-2973387c255d",
7       "project_id": "019010a2-8327-2607-11d7-41bb0a8936d4",
8       "created": "2024-06-13T14:01:03Z",
9       "modified": "2024-06-13T14:01:03Z",
10       "active_revisions": [
11         {
12           "task_revision_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
13           "weight": 1
14         }
15       ],
16       "description": "A task to pre-triage user onboarding before IDV.",
17       "public": false,
18       "revisions": [
19         {
20           "system_prompt": "You are an expert software program specifically designed for the fintech industry that will be used for pre-triage tasks to ensure the best possible client UX and efficient 3rd party platform interoperability.",
21           "user_prompt": "Your task is to validate the uploaded image and determine whether it will be suitable for authentication and onboarding checks. If the image of the person is clear and typical of a passport style photo then set the compliance field to true. Provide rationale for your decision in the rationale field. If the compliance result is false, then provide a helpful hint for the customer who has submitted the photo informing them why it is unacceptable and some steps to remedy it, place this into the hint field. Determine whether the following description matches the provided image: {description}",
22           "llm_model_id": "019011e6-e530-3aca-6cf7-2973387c255d",
23           "output_format": {
24             "compliance": "bool",
25             "hint": {
26               "type": "str"
27             },
28             "match": {
29               "type": "bool",
30               "description": "True if the provided description is a close match"
31             },
32             "rationale": "str"
33           },
34           "id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
35           "created": "2024-06-13T14:01:03Z",
36           "modified": "2024-06-13T14:01:03Z",
37           "llm_model": {
38             "provider": "OpenAI",
39             "vendor": "openai",
40             "name": "gpt-4-turbo-preview",
41             "alias": "GPT-4 Turbo",
42             "description": "Latest GPT-4 model with 128k context window and knowledge cutoff of December 2023.",
43             "supports_vision": true,
44             "id": "019011e6-e530-3aca-6cf7-2973387c255d",
45             "created": "2024-01-16T13:33:25Z",
46             "modified": "2024-01-16T13:33:25Z"
47           },
48           "input_params": [
49             "input_params"
50           ],
51           "llm_config": {
52             "temperature": 0.7
53           },
54           "task_forwarder_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
55           "rag": {
56             "collection_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
57             "rag_param": "context"
58           },
59           "image_required": true,
60           "optimise_images": true,
61           "test": false,
62           "input_processors": [
63             {
64               "param_name": "description",
65               "input_processor": "url_scraper",
66               "config": {
67                 "extract_text": true,
68                 "include_title": true,
69                 "max_length": 5000
70               }
71             }
72           ],
73           "annotation": "Production v2 - Added image matching capability",
74           "active": true,
75           "tags": [
76             {
77               "name": "production",
78               "entity_type": "task",
79               "id": "123e4567-e89b-12d3-a456-426614174000",
80               "project_id": "123e4567-e89b-12d3-a456-426614174001",
81               "created_at": "2024-01-29T12:34:56Z",
82               "is_project_tag": true,
83               "parent_id": "01909843-3596-da54-4756-28af46917e74"
84             }
85           ]
86         }
87       ],
88       "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjY1NmVkZWJkLTcyOWItNDhjNS1hYjk3LTFiYjgzNDM3ZGY5MyIsInR5cCI6IkpXVCJ1",
89       "tags": [
90         {
91           "name": "production",
92           "entity_type": "task",
93           "id": "123e4567-e89b-12d3-a456-426614174000",
94           "project_id": "123e4567-e89b-12d3-a456-426614174001",
95           "created_at": "2024-01-29T12:34:56Z",
96           "is_project_tag": true,
97           "parent_id": "01909843-3596-da54-4756-28af46917e74"
98         }
99       ]
100     }
101   ],
102   "pagination": {
103     "next_cursor": "019097c5-5560-05b5-4a48-5197a269683b",
104     "has_next": true,
105     "page_limit": 100
106   }
107 }

Built with

1	curl https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/task \
2	-H "Authorization: Bearer <token>"

1	{
2	"results": [
3	{
4	"name": "Fintech Pre-Triage",
5	"enabled": true,
6	"id": "019011e6-e530-3aca-6cf7-2973387c255d",
7	"project_id": "019010a2-8327-2607-11d7-41bb0a8936d4",
8	"created": "2024-06-13T14:01:03Z",
9	"modified": "2024-06-13T14:01:03Z",
10	"active_revisions": [
11	{
12	"task_revision_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
13	"weight": 1
14	}
15	],
16	"description": "A task to pre-triage user onboarding before IDV.",
17	"public": false,
18	"revisions": [
19	{
20	"system_prompt": "You are an expert software program specifically designed for the fintech industry that will be used for pre-triage tasks to ensure the best possible client UX and efficient 3rd party platform interoperability.",
21	"user_prompt": "Your task is to validate the uploaded image and determine whether it will be suitable for authentication and onboarding checks. If the image of the person is clear and typical of a passport style photo then set the compliance field to true. Provide rationale for your decision in the rationale field. If the compliance result is false, then provide a helpful hint for the customer who has submitted the photo informing them why it is unacceptable and some steps to remedy it, place this into the hint field. Determine whether the following description matches the provided image: {description}",
22	"llm_model_id": "019011e6-e530-3aca-6cf7-2973387c255d",
23	"output_format": {
24	"compliance": "bool",
25	"hint": {
26	"type": "str"
27	},
28	"match": {
29	"type": "bool",
30	"description": "True if the provided description is a close match"
31	},
32	"rationale": "str"
33	},
34	"id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
35	"created": "2024-06-13T14:01:03Z",
36	"modified": "2024-06-13T14:01:03Z",
37	"llm_model": {
38	"provider": "OpenAI",
39	"vendor": "openai",
40	"name": "gpt-4-turbo-preview",
41	"alias": "GPT-4 Turbo",
42	"description": "Latest GPT-4 model with 128k context window and knowledge cutoff of December 2023.",
43	"supports_vision": true,
44	"id": "019011e6-e530-3aca-6cf7-2973387c255d",
45	"created": "2024-01-16T13:33:25Z",
46	"modified": "2024-01-16T13:33:25Z"
47	},
48	"input_params": [
49	"input_params"
50	],
51	"llm_config": {
52	"temperature": 0.7
53	},
54	"task_forwarder_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
55	"rag": {
56	"collection_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
57	"rag_param": "context"
58	},
59	"image_required": true,
60	"optimise_images": true,
61	"test": false,
62	"input_processors": [
63	{
64	"param_name": "description",
65	"input_processor": "url_scraper",
66	"config": {
67	"extract_text": true,
68	"include_title": true,
69	"max_length": 5000
70	}
71	}
72	],
73	"annotation": "Production v2 - Added image matching capability",
74	"active": true,
75	"tags": [
76	{
77	"name": "production",
78	"entity_type": "task",
79	"id": "123e4567-e89b-12d3-a456-426614174000",
80	"project_id": "123e4567-e89b-12d3-a456-426614174001",
81	"created_at": "2024-01-29T12:34:56Z",
82	"is_project_tag": true,
83	"parent_id": "01909843-3596-da54-4756-28af46917e74"
84	}
85	]
86	}
87	],
88	"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjY1NmVkZWJkLTcyOWItNDhjNS1hYjk3LTFiYjgzNDM3ZGY5MyIsInR5cCI6IkpXVCJ1",
89	"tags": [
90	{
91	"name": "production",
92	"entity_type": "task",
93	"id": "123e4567-e89b-12d3-a456-426614174000",
94	"project_id": "123e4567-e89b-12d3-a456-426614174001",
95	"created_at": "2024-01-29T12:34:56Z",
96	"is_project_tag": true,
97	"parent_id": "01909843-3596-da54-4756-28af46917e74"
98	}
99	]
100	}
101	],
102	"pagination": {
103	"next_cursor": "019097c5-5560-05b5-4a48-5197a269683b",
104	"has_next": true,
105	"page_limit": 100
106	}
107	}