---
title: "List Embed Jobs"
method: GET
path: "/v1/embed-jobs"
tags: ["embedJobs"]
---

# List Embed Jobs

`GET /v1/embed-jobs`

## Request

- Base URL: `https://api.cohere.com`
- URL: `https://api.cohere.com/v1/embed-jobs`
- Auth: HTTP bearer

The list embed job endpoint allows users to view all embed jobs history for that specific user.

## Headers

- `X-Client-Name` string

## Response `200`

OK

- ListEmbedJobResponse
  - `embed_jobs` EmbedJob[]
    - `job_id` string, required: ID of the embed job
    - `name` string: The name of the embed job
    - `status` 'processing' | 'complete' | 'cancelling' | 'cancelled' | 'failed', required: The status of the embed job
    - `created_at` string, date-time, required: The creation date of the embed job
    - `input_dataset_id` string, required: ID of the input dataset
    - `output_dataset_id` string: ID of the resulting output dataset
    - `model` string, required: ID of the model used to embed
    - `truncate` 'START' | 'END', required: The truncation option used
    - `meta` ApiMeta
      - `api_version` ApiMetaApiVersion
        - `version` string, required
        - `is_deprecated` boolean
        - `is_experimental` boolean
      - `billed_units` ApiMetaBilledUnits
        - `images` number, double: The number of billed images.
        - `input_tokens` number, double: The number of billed input tokens.
        - `image_tokens` number, double: The number of billed image tokens.
        - `output_tokens` number, double: The number of billed output tokens.
        - `search_units` number, double: The number of billed search units.
        - `classifications` number, double: The number of billed classifications units.
        - `pages` number, double: The number of billed pages parsed.
      - `tokens` ApiMetaTokens
        - `input_tokens` number, double: The number of tokens used as input to the model.
        - `output_tokens` number, double: The number of tokens produced by the model.
      - `cached_tokens` number, double: The number of prompt tokens that hit the inference cache.
      - `warnings` string[]

## Other responses

- `400`: This error is returned when the request is not well formed. This could be because: - JSON is invalid - The request is missing required fields - The request contains an invalid combination of fields
- `401`: This error indicates that the operation attempted to be performed is not allowed. This could be because: - The api token is invalid - The user does not have the necessary permissions
- `403`: This error indicates that the operation attempted to be performed is not allowed. This could be because: - The api token is invalid - The user does not have the necessary permissions
- `404`: This error is returned when a resource is not found. This could be because: - The endpoint does not exist - The resource does not exist eg model id, dataset id
- `422`: This error is returned when the request is not well formed. This could be because: - JSON is invalid - The request is missing required fields - The request contains an invalid combination of fields
- `429`: Too many requests
- `498`: This error is returned when a request or response contains a deny-listed token.
- `499`: This error is returned when a request is cancelled by the user.
- `500`: This error is returned when an uncategorised internal server error occurs.
- `501`: This error is returned when the requested feature is not implemented.
- `503`: This error is returned when the service is unavailable. This could be due to: - Too many users trying to access the service at the same time
- `504`: This error is returned when a request to the server times out. This could be due to: - An internal services taking too long to respond

---

[API](https://skmtc.dev/cohere-ai/apis/cohere-api.md) · [All operations](https://skmtc.dev/cohere-ai/apis/cohere-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cohere-ai/apis/cohere-api/revisions/8e538a293bd3?raw)