Skip to main content
GET

Authorizations

Api-Key
string
header
required

An API Key is required to call Pinecone APIs. Get yours from the console.

Headers

X-Pinecone-Api-Version
string
default:2026-07
required

Required date-based version header

Path Parameters

job_id
string
required

The ID of the conversion job to describe.

Response

The status and progress of the conversion job.

The status and progress of a job that converts a vector index into a document index.

conversion_job_id
string
required

Identifies the job when describing or cancelling it.

Example:

"670e8400-e29b-41d4-a716-446655440001"

source_index_id
string
required

Identifies the vector index the job reads from. Stays set after that index is deleted.

Example:

"670e8400-e29b-41d4-a716-446655440000"

target_index_name
string
required

Name of the document index the job fills.

Example:

"example-index-docs"

target_index_id
string
required

ID of the document index the job fills.

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
string
required

Status of the conversion job.

Possible values: Pending, InProgress, Completed, Failed, or Cancelled.

Example:

"InProgress"

created_at
string<date-time>
required

Timestamp when the conversion job was created.

Example:

"2026-10-07T10:30:00.000Z"

source_index_name
string | null

Name of the index being converted. null once that index has been deleted.

Example:

"example-index"

error_mode
object

How a conversion handles a source record the new index cannot take, such as a record whose metadata value for a full_text_search field is not a string. Records the schema can hold are never affected. If omitted, on_error is abort.

percent_complete
number<float>

Progress of the conversion job, from 0 to 100. Absent until the job has started.

Required range: 0 <= x <= 100
Example:

42.5

records_converted
integer<int64>

The number of source records written to the document index so far.

Required range: x >= 0
Example:

425000

records_skipped
integer<int64>

The number of source records skipped because the document index cannot take them. Always 0 when error_mode.on_error is abort.

Required range: x >= 0
Example:

0

error
string | null

Why the job failed, when its status is Failed. null otherwise.

Example:

"Record doc-17: the metadata value for full-text search fieldchunk_textis a number, not a string."

completed_at
string<date-time> | null

Timestamp when the conversion job ended as Completed, Failed, or Cancelled. null until then.

Example:

"2026-10-07T11:05:00.000Z"