Skip to main content

Quickstart

This guide walks you through making your first API request and handling the response.

Prerequisites

  • An Sigmic AI account
  • An API key (create one in Settings > Developer)

Step 1: Create Your First Task

The simplest way to test the API is with cURL:
You’ll get a JSON response with the task ID:

Step 2: Stream the Execution

Connect to the stream endpoint to watch the task execute in real-time:
You’ll see Server-Sent Events streaming back:

Step 3: Send a Follow-up

Send a follow-up message, then reconnect to the stream:

Complete Working Example

Here’s a minimal working example in Node.js:

What’s Next?

Upload Files

Learn how to include files in your tasks

Stream Events

Understand the unified SSE stream endpoint

Artifacts

List and download files generated by the agent

Tool Approval

Control which tools the agent can execute