Aicoo
    LoginContact salesTry Aicoo
    Try Aicoo

    Aicoo API

    Layer 1: Intro + API Key

    Everything needed to authenticate and make your first successful API request.

    Start Here

    5 Minutes

    Create a key, set the auth header, call init/chat, then move into Agent and OS docs.

    Manage API keysOpenAPI 3.0 specification (JSON)Extended API catalog (JSON)llms.txt for agentsBack to docs hub
    Build on AicooOverview1. Intro + API Key2. Aicoo Agent3. Aicoo OS + Tools4. OAuth / OIDC
    Build on SharedOSAgent Network API
    ReferenceAPI StatusOpenAPI 3.0 JSON

    On This Page

    Setup

    Get API KeyAuth HeaderBase URL

    First Calls

    Starter EndpointsInitialize WorkspaceSend First Agent Message

    Limits + Errors

    Rate LimitsCommon Errors

    Get API Key

    Create a key from settings

    1. Open Settings → API Keys.

    2. Create a new key and copy the secret immediately.

    3. Store it in your environment as `AICOO_API_KEY` (legacy `PULSE_API_KEY` also works).

    export AICOO_API_KEY="aicoo_sk_live_..."

    Authentication

    Use Bearer auth on every request

    All v1 routes are Bearer protected. Include this header in each request — with a user API key, or a Login with Aicoo OAuth access token (see the OAuth page for the resource parameter requirement).

    Authorization: Bearer YOUR_API_KEY

    Base URL

    Path prefix for all endpoints

    https://www.yourcoo.ai/api/v1

    First Calls

    Starter endpoints

    Recommended first sequence: initialize workspace, then send first agent message.

    POST/api/v1/initGA

    Initialize Workspace

    Idempotently initializes workspace state and returns folder/file totals.

    • Safe to call on every client bootstrap.
    • Ensures default /General folder exists.
    • Returns complete folder tree and total storage footprint.

    Parameters

    NameInTypeRequired
    No path/query/body parameters required.

    Request Example

    curl -X POST https://www.yourcoo.ai/api/v1/init \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{}'

    Example Output

    {
      "success": true,
      "initialized": true,
      "workspace": {
        "folders": [
          { "id": 1, "name": "General", "parentId": null, "icon": null, "fileCount": 3 }
        ],
        "totalFiles": 3,
        "totalSizeBytes": 24576
      }
    }
    POST/api/v1/chatGA

    Send First Agent Message

    Sends a message through the Aicoo Agent runtime.

    • Uses the same agent-v04 execution path as first-party product chat.
    • Streaming is enabled by default.
    • Supports conversation continuation via conversationId.

    Parameters

    NameInTypeRequired
    message

    Prompt text for the agent.

    bodystringYes
    userTimezone

    IANA timezone. Defaults to UTC.

    bodystringNo
    stream

    Set false to disable streaming response events.

    bodybooleanNo

    Request Example

    curl -X POST https://www.yourcoo.ai/api/v1/chat \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "message": "Give me a concise plan for today",
        "userTimezone": "America/New_York",
        "stream": true
      }'

    Example Output

    {"type":"text-delta","textDelta":"Here is your plan for today..."}
    {"type":"tool-call-start","toolName":"search_calendar_events","toolCallId":"call_123"}
    {"type":"completion","metadata":{"promptTokens":812,"completionTokens":191,"totalTokens":1003}}

    Rate Limits

    TierRequests/minTokens/week
    Free101,200,000
    Pro606,000,000
    Business30025,000,000

    Common Errors

    unauthorizedHTTP 401

    Missing or invalid API key.

    invalid_requestHTTP 400

    Malformed JSON or input validation failed.

    not_foundHTTP 404

    Resource not found for authenticated user.

    parse_errorHTTP 500

    AI output could not be parsed into expected JSON shape.

    server_errorHTTP 500

    Unhandled server-side failure.

    Next Layer

    Move to Aicoo Agent docs

    Continue with the dedicated Agent layer for chat and briefing endpoints.

    Open Aicoo Agent layer
    © 2026 Aicoo/SysteMind, Inc. (USA)
    SecurityDocsBlogTermsPrivacyDelete account