Fetch an Embed Job

GET

This API retrieves the details about an embed job started by the same user.

Path parameters

idstringRequired

The ID of the embed job to retrieve.

Headers

X-Client-NamestringOptional

The name of the project that is making the request.

Response

This endpoint returns an object.

job_idstring

ID of the embed job

statusenum

Allowed values: processingcompletecancellingcancelledfailed

The status of the embed job

created_atdatetime

The creation date of the embed job

input_dataset_idstring

ID of the input dataset

modelstring

ID of the model used to embed

truncate"START" or "END"

Allowed values: STARTEND

The truncation option used

namestringOptional

The name of the embed job

output_dataset_idstringOptional

ID of the resulting output dataset

metaobjectOptional

GET

1 import cohere
2 
3 co = cohere.Client("<<apiKey>>")
4 
5 # get embed job
6 response = co.embed_jobs.get("job_id")
7 
8 print(response)

200Retrieved

1 {
2   "job_id": "job_id",
3   "status": "processing",
4   "created_at": "2024-01-15T09:30:00Z",
5   "input_dataset_id": "input_dataset_id",
6   "model": "model",
7   "truncate": "START",
8   "name": "name",
9   "output_dataset_id": "output_dataset_id",
10   "meta": {
11     "api_version": {
12       "version": "version",
13       "is_deprecated": true,
14       "is_experimental": true
15     },
16     "billed_units": {
17       "input_tokens": 1.1,
18       "output_tokens": 1.1,
19       "search_units": 1.1,
20       "classifications": 1.1
21     },
22     "tokens": {
23       "input_tokens": 1.1,
24       "output_tokens": 1.1
25     },
26     "warnings": [
27       "warnings"
28     ]
29   }
30 }

Cancel an Embed Job

Up Next

Built with

1	import cohere
2
3	co = cohere.Client("<<apiKey>>")
4
5	# get embed job
6	response = co.embed_jobs.get("job_id")
7
8	print(response)

1	{
2	"job_id": "job_id",
3	"status": "processing",
4	"created_at": "2024-01-15T09:30:00Z",
5	"input_dataset_id": "input_dataset_id",
6	"model": "model",
7	"truncate": "START",
8	"name": "name",
9	"output_dataset_id": "output_dataset_id",
10	"meta": {
11	"api_version": {
12	"version": "version",
13	"is_deprecated": true,
14	"is_experimental": true
15	},
16	"billed_units": {
17	"input_tokens": 1.1,
18	"output_tokens": 1.1,
19	"search_units": 1.1,
20	"classifications": 1.1
21	},
22	"tokens": {
23	"input_tokens": 1.1,
24	"output_tokens": 1.1
25	},
26	"warnings": [
27	"warnings"
28	]
29	}
30	}