Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API 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.
openapi: 3.2.0
info:
title: Orbit Apps Skills API
version: 1.0.0
description: Public REST API for Orbit Apps.
servers:
- url: https://api.orbitapps.io
description: Production
security:
- bearerAuth: []
tags:
- name: Skills
paths:
/api/v1/skills/{name}:
get:
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
name:
type: string
instructions:
description: The skill's text, after the text of every skill it uses.
type: string
required:
- name
- instructions
additionalProperties: false
'404':
content:
application/json:
schema:
type: object
properties: {}
additionalProperties: false
tags:
- Skills
summary: Read how one kind of app work is done well
description: 'The skill Orbit''s own Builder reads before that work, with every skill it uses: `design-screen` (what a screen is for, its layout, the generic look to avoid, real words and pictures, every state; it includes `app-look` and `interactions`), `app-look` (colour with the theme''s tokens, and type), `interactions` (hover, focus and motion), `app-images` (a real image in every slot) and `compose-look` (the paper, the ink, the primary colour, the faces and the shape that make an app look like its own product; Explorer''s text). For what a screen saves and loads: `model-app-data` (the app''s own tables; it includes how to build on the platform''s tables), `write-workflows` (the server-side logic that lists, saves and changes rows) and `wire-screens` (a form, a button or a list that runs a workflow). The text names the agents'' own tools, such as `read_recipe` for GET /api/v1/recipes/{slug}.'
operationId: getApiV1SkillsByName
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