Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
API reference

Upload a manifest

Updated
POST/manifestsView examples
Read as Markdown

Fictional API example. This page demonstrates documentation features; its operations do not describe a live service.

This reference is generated from the OpenAPI description. It shows the operation contract; follow any related guides below for task steps and context.

OpenAPI for this operation: Download JSON.

POST /manifests

Upload a manifest

Servers

https://sandbox.api.cedar-parcel.example/v1 — Sandbox

https://api.cedar-parcel.example/v1 — Production

Authentication

Use one of these authentication options:

Bearer token

HTTP bearer (JWT).

Short-lived service token.

API key

API key in header X-Parcel-Key.

Long-lived account key.

Request body

Required.

multipart/form-data

object

2 properties

  • manifest string required ⓘ

    format: binary

    Dispatch data file.

  • checksum string required ⓘ

    format: binary

    Separate checksum file.

Responses

202: Accepted

application/json

Upload accepted for validation.

object

2 properties

  • jobId string always present ⓘ

  • status enum<string> always present ⓘ

    Available options: "queued", "validating"