How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kargo

Kargo Documents API

The Documents API from Kargo — 1 operation(s) for documents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kargo Documents API is one of 3 APIs that Kargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 1 operation across 1 path, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /v1.

1 operations 1 paths 12 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.kargo.zone/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kargo Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 1
POST
/documents
Create or update a document (shipment / order / order items)
createDocument 1 param body → 200201400401403404409415

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Document (26 properties), OrderItemInput (18 properties), BatchOrderInput (13 properties), Shipment (8 properties). Each schema is shown below with its type and property counts.

BatchOrderInput
object
One order inside a shipment level multi order document. orderNumber identifies the order. Each order can provide its own orderItemUpdateStrategy, so different…
13 properties 1 required
Order
object
4 properties
CaseSerial
object
2 properties 2 required
ShipmentAdditionalField
object
2 properties 2 required
DocumentResult
object
4 properties 3 required
OrderDirection
string
Document
object
Flattened shipment + order + order-item document. This schema supports two formats: the existing single order format with top level orderNumber, and a shipment…
26 properties 3 required
OrderItemUpdateStrategy
string
How the incoming items reconcile with items already on the matched order: If omitted and items are provided, defaults to OVERWRITE. If no items are provided, e…
Shipment
object
The resulting shipment after the document is processed.
8 properties
EntityRef
object
3 properties 2 required
OrderItemInput
object
18 properties
Problem
object
RFC 9457 problem detail.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kargo-documents-api-openapi.yml Raw ↑

Other APIs Kargo publishes across the network.

Kargo Public GraphQL API
AE Profile APIs.io
Kargo SKU Master API
AE Profile APIs.io
#Documents
← Back to K APIs
API Details
ID
kargo:kargo-documents-api
Base URL
https://api.kargo.zone/v1
Docs
https://docs.kargo.ai/rest-api
Provider
Kargo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=kargo-documents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kargo-documents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Kargo Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.