API Reference

{
  /** JWT subject — stable string ID for the user. */
  sub: string;
  /** Display name of the user. */
  name: string | null;
  /** Email address of the user. */
  email: string | null;
  /** Internal numeric user ID. */
  korey_user_id: integer;
  /** Internal numeric organization ID. */
  korey_organization_id: integer;
  /** URL-safe organization slug. */
  korey_organization_slug: string;
  /** User role within the organization. */
  role: string;
}

{
  /** Array of message objects. */
  data: [
    {
      /** Unique message ID. */
      id: string;
      /** ID of the thread this message belongs to. */
      thread_id: string;
      /** Who sent the message. */
      role: "user" | "assistant" | "summary";
      /** Ordered list of content blocks that make up the message. */
      contents: [
        {
            type: "text";
            text: string;
          }
        | {
            type: "image";
            attachment_id: string;
          }
        | {
            type: "document";
            attachment_id: string;
          }
        | {
            type: "user_get_choice";
            tool_use_id: string;
            question: string;
            choices: string[];
          }
      ];
      /** ISO 8601 timestamp when the message was created. */
      created_at: string;
      /** Direct link to this message in the Korey web app. */
      app_url: string;
    }
  ];
  /** ID of the first message in the page. */
  first_id: string | null;
  /** ID of the last message in the page. Pass as ?after= to fetch the next page. */
  last_id: string | null;
  /** True when there are more messages beyond this page. */
  has_more: boolean;
  /** The limit applied to this request. */
  limit: integer;
}

{
  /** ID of the newly created message. Use this to poll or stream the AI response. */
  message_id: string;
}

{
  /** Array of thread objects. */
  data: [
    {
      /** Unique thread ID. */
      id: string;
      /** Optional display name for the thread. */
      name: string | null;
      /** Current processing state of the thread. */
      state: "ready" | "waiting" | "active" | "error" | "interrupted";
      /** When true the thread is only visible to its owner. */
      is_private: boolean;
      /** Whether the thread has been archived. */
      archived: boolean;
      /** The user who created the thread. */
      owner: {
        /** Owner user ID. */
        id: string;
        /** Owner display name. */
        name: string | null;
      };
      /** ISO 8601 timestamp when the thread was created. */
      created_at: string;
      /** ISO 8601 timestamp when the thread was last updated. */
      updated_at: string;
      /** Direct link to this thread in the Korey web app. */
      app_url: string;
    }
  ];
  /** ID of the first item in the page. null when the page is empty. */
  first_id: string | null;
  /** ID of the last item in the page. Pass as ?after= to fetch the next page. */
  last_id: string | null;
  /** True when there are more results beyond this page. */
  has_more: boolean;
  /** The limit applied to this request. */
  limit: integer;
}

{
  /** ID of the newly created thread. */
  thread_id: string;
  /** ID of the initial message. */
  message_id: string;
}

{
  /** Unique thread ID. */
  id: string;
  /** Optional display name for the thread. */
  name: string | null;
  /** Current processing state of the thread. */
  state: "ready" | "waiting" | "active" | "error" | "interrupted";
  /** When true the thread is only visible to its owner. */
  is_private: boolean;
  /** Whether the thread has been archived. */
  archived: boolean;
  /** The user who created the thread. */
  owner: {
    /** Owner user ID. */
    id: string;
    /** Owner display name. */
    name: string | null;
  };
  /** ISO 8601 timestamp when the thread was created. */
  created_at: string;
  /** ISO 8601 timestamp when the thread was last updated. */
  updated_at: string;
  /** Direct link to this thread in the Korey web app. */
  app_url: string;
}

{
  status: "complete";
  messages: [
    {
      /** Unique message ID. */
      id: string;
      /** ID of the thread this message belongs to. */
      thread_id: string;
      /** Who sent the message. */
      role: "user" | "assistant" | "summary";
      /** Ordered list of content blocks that make up the message. */
      contents: [
        {
            type: "text";
            text: string;
          }
        | {
            type: "image";
            attachment_id: string;
          }
        | {
            type: "document";
            attachment_id: string;
          }
        | {
            type: "user_get_choice";
            tool_use_id: string;
            question: string;
            choices: string[];
          }
      ];
      /** ISO 8601 timestamp when the message was created. */
      created_at: string;
      /** Direct link to this message in the Korey web app. */
      app_url: string;
    }
  ];
}

{
  status: "processing";
}