EXexa
Imports

Create an Import

Changed on

Creates an Import for your own data. Upload the file to the returned uploadUrl before uploadValidUntil, 1 hour after creation. Use an Import to enrich its records, to search within them with scope, or to leave them out of searches with exclude.

post/v0/imports

Request

  • Base URL
    https://api.exa.ai/websets
  • URL
    https://api.exa.ai/websets/v0/imports
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

sizenumber required

The size of the file in bytes. Maximum size is 50 MB.

countnumber required

The number of records to import

titlestring

The title of the import

format'csv' required

The file format. The CSV must include a column that identifies each entity, or the import fails.

metadataobject

Set of key-value pairs you want to associate with this object.

Response

Import created successfully

idstring required

The unique identifier for the Import

object'import' required

The type of object

status'pending' | 'processing' | 'completed' | 'failed' | 'canceled' required

The status of the Import

format'csv' | 'webset' required

The format of the import.

titlestring required

The title of the import

countnumber required

The number of entities in the import

metadataobject required

Set of key-value pairs you want to associate with this object.

failedReason'invalid_format' | 'invalid_file_content' | 'missing_identifier' nullable required

The reason the import failed

failedAtstring date-time nullable required

When the import failed

failedMessagestring nullable required

A human readable message of the import failure

createdAtstring date-time required

When the import was created

updatedAtstring date-time required

When the import was last updated

uploadUrlstring required

The URL to upload the file to

uploadValidUntilstring required

The date and time until the upload URL is valid. The upload URL will be valid for 1 hour.

Changes

  • a56858d08d37Revision changes
    • warning

      the // request property's maxLength was set to 250

  • a345d0f03b0dRevision changes
    • breaking

      added 'propertyNames' constraint to the request property /

    • info

      added 'propertyNames' constraint to the response property for the status