Orbit Artifacts API
Uploaded files — a design's own assets (logo, hero photo) and files an agent reads
Uploaded files — a design's own assets (logo, hero photo) and files an agent reads
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/orbitapps-io:orbitapps-io-artifacts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Orbit Apps Artifacts API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Artifacts
description: Uploaded files — a design's own assets (logo, hero photo) and files an agent reads
paths:
/api/v1/artifacts/{id}/content:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Artifact id.
responses:
'200':
description: The bytes.
'404':
description: Not found.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Get an artifact's bytes (legacy)
description: Compatibility endpoint. Use content_url for public artifacts. A public artifact answers without a token. A private one needs the org-scoped token that owns it.
security:
- {}
- bearerAuth: []
operationId: getApiV1ArtifactsByIdContent
x-operation-id-source: derived
/images/v1/{width}/{id}.{ext}:
get:
parameters:
- in: path
name: width
required: true
schema:
type: string
enum:
- '320'
- '640'
- '960'
- '1280'
- '1920'
- in: path
name: id
required: true
schema:
type: string
format: uuid
- in: path
name: ext
required: true
schema:
type: string
enum:
- jpg
- png
- webp
- avif
tags:
- Artifacts
summary: Redirect to the original public image
security:
- {}
operationId: getImagesV1ByWidthById}{ext
x-operation-id-source: derived
head:
parameters:
- in: path
name: width
required: true
schema:
type: string
enum:
- '320'
- '640'
- '960'
- '1280'
- '1920'
- in: path
name: id
required: true
schema:
type: string
format: uuid
- in: path
name: ext
required: true
schema:
type: string
enum:
- jpg
- png
- webp
- avif
tags:
- Artifacts
summary: Redirect to the original public image
security:
- {}
operationId: headImagesV1ByWidthById}{ext
x-operation-id-source: derived
/api/v1/artifacts:
post:
requestBody:
content:
application/json:
schema:
type: object
properties:
filename:
description: The file's name, such as `logo.png`.
type: string
minLength: 1
content_type:
description: Its MIME type; else its name's extension says it.
type: string
size_bytes:
description: 'Its exact size: the link takes exactly these bytes.'
type: integer
minimum: 1
app:
description: The app it is for.
type: string
format: uuid
visibility:
description: '`private` (default), or `public`.'
type: string
required:
- filename
- size_bytes
additionalProperties: false
responses:
'201':
description: Where to send the file's bytes.
content:
application/json:
schema:
type: object
properties:
artifact_id:
type: string
format: uuid
upload_url:
type: string
expires_in:
type: integer
required:
- artifact_id
- upload_url
- expires_in
additionalProperties: false
'403':
description: Token has no org scope.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'413':
description: Over 32 MB.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'501':
description: The store cannot sign a link.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Ask to upload an artifact
description: 'Ask where to send a file: its `filename`, `content_type` and exact `size_bytes` (32 MB at most). Optional: `app` scopes it to one app, `visibility` (`private` default, or `public` to serve the bytes without a token). Answers a pending `artifact_id` and an `upload_url`: PUT the file''s exact bytes there, then POST `/artifacts/{id}/add`.'
operationId: postApiV1Artifacts
x-operation-id-source: derived
/api/v1/artifacts/{id}:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Artifact id.
responses:
'200':
description: Artifact metadata + fresh url.
content:
application/json:
schema:
type: object
properties:
original_name:
type: string
content_url:
oneOf:
- type: string
- type: 'null'
mime_type:
type: string
app_id:
oneOf:
- type: string
format: uuid
- type: 'null'
width:
oneOf:
- type: integer
- type: 'null'
checksum:
oneOf:
- type: string
- type: 'null'
id:
type: string
format: uuid
url:
oneOf:
- type: string
- type: 'null'
visibility:
type: string
created_at:
oneOf:
- type: string
- type: 'null'
height:
oneOf:
- type: integer
- type: 'null'
size_bytes:
type: integer
required:
- id
- app_id
- original_name
- mime_type
- size_bytes
- visibility
- url
- content_url
- created_at
additionalProperties: false
'404':
description: Not found.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Get an artifact
operationId: getApiV1ArtifactsById
x-operation-id-source: derived
delete:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Artifact id.
responses:
'204':
description: Artifact deleted.
'404':
description: Not found.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Delete an artifact
operationId: deleteApiV1ArtifactsById
x-operation-id-source: derived
/api/v1/artifacts/{id}/add:
post:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
description: Artifact id the ask answered.
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
duration_us:
description: A sound's or video's length, in microseconds.
type: integer
minimum: 1
maximum: 3600000000
waveform:
description: 'A voice note''s wave: up to 64 heights from 0 to 100.'
type: array
items:
type: integer
minimum: 0
maximum: 100
minItems: 1
maxItems: 64
additionalProperties: false
- type: 'null'
responses:
'200':
description: The added artifact.
content:
application/json:
schema:
type: object
properties:
original_name:
type: string
content_url:
oneOf:
- type: string
- type: 'null'
mime_type:
type: string
app_id:
oneOf:
- type: string
format: uuid
- type: 'null'
width:
oneOf:
- type: integer
- type: 'null'
checksum:
oneOf:
- type: string
- type: 'null'
id:
type: string
format: uuid
url:
oneOf:
- type: string
- type: 'null'
visibility:
type: string
created_at:
oneOf:
- type: string
- type: 'null'
height:
oneOf:
- type: integer
- type: 'null'
size_bytes:
type: integer
required:
- id
- app_id
- original_name
- mime_type
- size_bytes
- visibility
- url
- content_url
- created_at
additionalProperties: false
'400':
description: Its bytes have not come.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
'404':
description: Not found.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Add an uploaded artifact
description: 'Once its bytes are PUT to its `upload_url`: the file''s checksum and a picture''s size are read off them. A sound or a video may say its length in microseconds, `duration_us`; a sound may also say its wave, `waveform`.'
operationId: postApiV1ArtifactsByIdAdd
x-operation-id-source: derived
/artifacts/{id}.{ext}:
get:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
- in: path
name: ext
required: true
schema:
type: string
responses:
'200':
description: The immutable bytes.
'404':
description: Not found.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Get a public artifact's bytes
security:
- {}
operationId: getArtifactsById}{ext
x-operation-id-source: derived
head:
parameters:
- in: path
name: id
required: true
schema:
type: string
format: uuid
- in: path
name: ext
required: true
schema:
type: string
responses:
'200':
description: The immutable bytes.
'404':
description: Not found.
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Artifacts
summary: Get a public artifact's bytes
security:
- {}
operationId: headArtifactsById}{ext
x-operation-id-source: derived
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: opaque
description: 'An Orbit api token, sent as `Authorization: Bearer <token>`.
Mint one with the RFC 8628 device-authorization grant (`POST /api/v1/device/code`, then poll `POST /api/v1/device/token`), or from Studio.
Every token carries a scope set from the `[verb resource]` RBAC catalog — `read:app`, `write:deployment`, `manage:secret`, and so on. The full vocabulary is published as `scopes_supported` at `/.well-known/oauth-protected-resource` (RFC 9728) and `/.well-known/oauth-authorization-server` (RFC 8414). Grant an agent the narrowest set that does its job.'
externalDocs:
description: Full documentation
url: https://docs.orbitapps.io
x-id:
- reitit.openapi/default