Documentation
Changelog

May 8th, 2026

Deploy AI agents programmatically, no UI needed — 08 May 2026 Update

You can now create and manage AI agents directly from your application using our REST API. Instead of configuring agents through the interface, send a single API request with your agent's name, description, system prompt, and greeting messages. Your agent is created, configured, and ready to use instantly.

This is perfect for platforms integrating Swiftask, SaaS products offering white-label agents, or teams managing large agent fleets across different projects.

Create Agent API

The new Create Agent endpoint lets you automate agent deployment. Define all required properties (name, description in English and French, system prompt, greeting messages), send a POST request to https://api.swiftask.fr/admin/agent/create, and receive your agent's ID, slug, and status in response.

  • Endpoint: POST https://api.swiftask.fr/admin/agent/create

  • Required fields: 6 mandatory properties (name, description, descriptionFR, systemPrompt, greetingMessage, greetingMessageFR)

  • Field constraints: Agent name up to 100 characters; description up to 500 characters

  • Response: Agent ID, slug, status, and creation timestamps

  • SDK compatible: Works with OpenAI SDK (Python, JavaScript, TypeScript, Node.js)

  • Streaming: Full support for real-time responses via Server-Sent Events (SSE)

  • Available on: All paid plans (Pro, Team Starter, Team Growth, Tailored) with no usage limits

  • Find it in: Agent Settings → API tab

How to test it:

  1. Go to Account Settings → API → Create new key. Copy it immediately (displayed only once).

  2. Open your agent → Agent Settings (gear icon) → API tab → Copy your agent slug.

  3. Install the OpenAI SDK: pip install openai (Python) or npm install openai (JavaScript).

  4. Use this Python example to test:

    from openai import OpenAI client = OpenAI(api_key="YOUR_API_KEY", base_url="https://api.swiftask.fr/v1") response = client.chat.completions.create( model="your-agent-slug", messages=[{"role": "user", "content": "Test message"}] ) print(response.choices[0].message.content)

  5. Verify the agent responds using its configured knowledge base and skills.

Use cases:

  • Platform integration: Embed Swiftask agent creation into your SaaS product

  • White-label agents: Let your customers deploy branded AI agents without accessing Swiftask directly

  • Fleet management: Automate agent creation and configuration across your organization

  • Custom workflows: Build agents programmatically as part of your business logic

Write a comment...