For the complete documentation index, see llms.txt. This page is also available as Markdown.

Glossary

Term
Definition

API Key

A unique secret token used to authenticate requests to the Origin Studio API. API keys identify the calling client and determine access permissions.

API keys must be included in the Authorization header of every request.

Authentication

The process of verifying the identity of a client making API requests. Origin Studio uses API key–based authentication.

Authorization

The mechanism that determines what actions an authenticated client is allowed to perform.

Authorization is handled by including a valid API key in the request header.

Endpoint

A specific URL path within the API that performs a defined operation.

Examples:

  • GET /v1/records

  • POST /v1/records

  • GET /v1/records/{id}

Each endpoint corresponds to a resource or action.

Resource

An object managed by the API.

Examples:

  • Record

  • Title

  • Metadata entity

Resources are accessed and modified via endpoints.

JSON

JavaScript Object Notation — a lightweight data-interchange format used for API requests and responses.

All Origin Studio API requests and responses use JSON.

Example:

JSON:API

A specification that standardizes how APIs structure requests and responses using JSON.

Origin Studio responses follow the JSON:API format, including:

  • jsonapi

  • data

  • errors

HTTP Method

The action performed on a resource.

Common methods:

  • GET – Retrieve data

  • POST – Create a resource

  • PUT / PATCH – Update a resource

  • DELETE – Remove a resource

Header

Metadata included in an HTTP request or response.

Example:

Authorization: Bearer YOUR_API_KEY

Headers are used for authentication, content type, and request handling.

Webhook

An HTTP callback triggered when an event occurs.

Origin Studio uses Amazon SNS to notify external systems when records are created or updated.

Last updated