Get an embedding task's status

GET 
/ai/embeddings/:task_id

Check the status of a current embedding task. Will be one of the following:

• queued - Task is waiting to be picked up by a worker
• processing - The embedding task is running
• success - Task completed successfully and the bucket is embedded
• failure - Task failed and no files were embedded successfully
• partial_success - Some files were embedded successfully, but at least one failed

Request

Path Parameters

task_id Task Idrequired

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

task_id uuid

task_name Task Name (string)

status BackgroundTaskStatus (string)

Possible values: [queued, processing, success, failure, partial_success]

Status of an embeddings task.

created_at Created At (string)

finished_at Finished At (string)

{
  "data": {
    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "task_name": "string",
    "status": "queued",
    "created_at": "string",
    "finished_at": "string"
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/embeddings/:task_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "data": {
    "task_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "task_name": "string",
    "status": "queued",
    "created_at": "string",
    "finished_at": "string"
  }
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}