Skip to main content
GET
/
api
/
v1
/
ingest
/
batches
/
{batchId}
/ingest/batches/{batchId}
curl --request GET \
  --url https://api.evermuse.com/api/v1/ingest/batches/{batchId} \
  --header 'x-api-key: <api-key>'
{
  "batchId": "<string>",
  "status": "LANDING",
  "createdAt": 1709282096000,
  "acceptedCount": 1,
  "rejectedCount": 1,
  "totalErrorCount": 1,
  "errors": [
    {
      "index": 1,
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "source": "<string>",
  "type": "<string>",
  "attachmentDownloadTotal": 1,
  "attachmentDownloadComplete": 1,
  "attachmentDownloadFailed": 1,
  "attachmentDownloadStatus": "PENDING"
}

Documentation Index

Fetch the complete documentation index at: https://docs.evermuse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Your API key, sent as the x-api-key header. Create one in Settings > API Keys with api:write permission. Format: em_sk_...

Path Parameters

​
batchId
string
required

The batch ID returned when you sent your records.

Maximum string length: 128

Response

Batch status retrieved successfully.

​
batchId
string
required

Unique identifier for this batch.

Maximum string length: 128
​
status
enum<string>
required

Current processing status of the batch. See the batch lifecycle table in the endpoint description.

Available options:
LANDING,
LANDED,
PROCESSING,
COMPLETE,
FAILED
​
createdAt
number
required

When the batch was created, as Unix epoch milliseconds.

Example:

1709282096000

​
acceptedCount
integer
required

Number of records that passed validation.

Required range: x >= 0
​
rejectedCount
integer
required

Number of records that failed validation.

Required range: x >= 0
​
totalErrorCount
integer
required

Total number of validation errors across rejected records.

Required range: x >= 0
​
errors
object[]

Up to 20 validation errors for quick inspection.

Maximum array length: 20
​
source
string

Where the records in this batch came from.

​
type
string

The record type for this batch.

​
attachmentDownloadTotal
integer

Total number of attachments to be downloaded (shown when the batch includes file attachments).

Required range: x >= 0
​
attachmentDownloadComplete
integer

Number of attachments successfully downloaded.

Required range: x >= 0
​
attachmentDownloadFailed
integer

Number of attachments that failed to download.

Required range: x >= 0
​
attachmentDownloadStatus
enum<string>

Overall download status for the batch's attachments. Only shown when the batch includes file attachments.

Available options:
PENDING,
IN_PROGRESS,
COMPLETE,
PARTIAL_FAILURE,
FAILED