Get an embedding task's status

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

GET /ai/embeddings/{task_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const embedding = await client.ai.embeddings.retrieve('task_id');

console.log(embedding.data);

200

{
  "data": {
    "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_name": "<string>",
    "status": "queued",
    "created_at": "<string>",
    "finished_at": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

task_id · string · required

Response

200

application/json

Successful Response

data · object · required

Show child attributes