Imports
Describe an import
The describe_import
operation returns details of a specific import operation.
For guidance and examples, see Import data.
GET
/
bulk
/
imports
/
{id}
This feature is in public preview and available only on Standard and Enterprise plans.
Authorizations
Api-Key
string
headerrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Path Parameters
id
string
requiredRequired string length:
1 - 1000
Response
200 - application/json
The model for an import operation.
id
string
Unique identifier for the import operation.
Required string length:
1 - 1000
uri
string
The URI from where the data is imported.
status
enum<string>
The status of the operation.
Available options:
Pending
, InProgress
, Failed
, Completed
, Cancelled
createdAt
string
The start time of the import operation.
finishedAt
string
The end time of the import operation.
percentComplete
number
The progress made by the operation, as a percentage.
Required range:
0 < x < 100
recordsImported
integer
The number of records successfully imported.
error
string
The error message if the import process failed.
Was this page helpful?