embedJobs

Fetch an Embed Job

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

get/v1/embed-jobs/{id}

Request

  • Base URL: https://api.cohere.com
  • URL: https://api.cohere.com/v1/embed-jobs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the embed job to retrieve.

Headers

X-Client-Namestring

The name of the project that is making the request.

Response

OK

job_idstring required

ID of the embed job

namestring

The name of the embed job

status'processing' | 'complete' | 'cancelling' | 'cancelled' | 'failed' required

The status of the embed job

created_atstring date-time required

The creation date of the embed job

input_dataset_idstring required

ID of the input dataset

output_dataset_idstring

ID of the resulting output dataset

modelstring required

ID of the model used to embed

truncate'START' | 'END' required

The truncation option used

Changes

No recorded changes to this operation across all 1 revision of this API.