Get Tasks by Status

GET 
/ai/embeddings

Retrieve tasks for the user that are either queued, processing, failed, success or partial_success based on the query string. Defaults to queued and processing.

Request

Query Parameters

status string[]

List of task statuses i.e. status=queued&status=processing

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

user_id User Id (string)required

task_id Task Id (string)required

task_name Task Name (string)required

status BackgroundTaskStatus (string)required

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

Status of an embeddings task.

created_at date-timerequired

finished_at date-time

bucket Bucket (string)

]

{
  "data": [
    {
      "user_id": "string",
      "task_id": "string",
      "task_name": "string",
      "status": "queued",
      "created_at": "2024-07-26T07:42:15.261Z",
      "finished_at": "2024-07-26T07:42:15.261Z",
      "bucket": "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' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "data": [
    {
      "user_id": "string",
      "task_id": "string",
      "task_name": "string",
      "status": "queued",
      "created_at": "2024-07-26T07:46:17.141Z",
      "finished_at": "2024-07-26T07:46:17.141Z",
      "bucket": "string"
    }
  ]
}

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