Search documentation

Search for a topic, a control, or an event type.

    Docs / Developer / API

    API

    The OAIZ API reads resources, changes draft configurations, and publishes events from your own system.

    Authentication

    An API key belongs to a person or service account. Requests use that account’s current resource access. A service account key does not inherit the access of the person who created it.

    Request header
    Authorization: Bearer <API_KEY>

    Keep API keys on the server, outside browser code. API keys explains account ownership, creation, expiry and revocation.

    Resource operations

    Read
    List or retrieve workflows, jobs, events, execution records, knowledge documents, databases and apps. Resource access controls which results the account receives.
    Change
    Edit draft configuration, test saved work, and publish the checked branch. A draft change and a live run are separate operations.
    Publish
    Send an event from your system. Matching live workflows can react to it. Events documents its fields and request body.

    The public API address is https://api.oaiz.io. An HTTP 401 means authentication failed. An HTTP 403 means the account is not allowed to perform the operation. Error responses can include a message, an error identifier named slug, and hints.

    Collection responses

    List and search operations in the collection contract return their primary array as items. Empty results contain an empty array. Nested arrays and resource metadata keep their own fields. Full collections contain the complete result and omit hasMore and nextCursor.

    Empty full collection
    {"items": []}

    Cursor operations return one page by default and require items, hasMore and nextCursor. Send the returned cursor unchanged with the same filters to read the next page. The final page has hasMore false and nextCursor null, including when it fills the requested page size. Pending approvals also retain totalCount, the accessible matching count before the cursor is applied.

    Use cursor and pageSize for these operations. Most default to 20 items and accept 1 to 100. Cost entries default to 50 and accept up to 50,000. Chat sessions default to 10 and accept up to 50. The endpoint reference gives each operation’s budget. Retired paging inputs and routes are rejected.

    The generated SDKs provide page and item iterators for complete reads. TypeScript offers listWorkflowsPages and iterateListWorkflows. Python offers list_workflows_pages and iter_list_workflows. Go offers ListWorkflowsPages and IterateListWorkflows. Page iterators retain response metadata. Finish the iterator before treating its result as a complete inventory, and fail the read if any page fails.

    Endpoint reference

    The API reference lists paths, parameters, request bodies, and responses. The OpenAPI schema describes the same operations for client tools.