ResourcesDeveloper
Developer
API Doc
12 min read

Mixoop Platform REST & GraphQL API Quickstart

Complete developer reference for authenticating, querying microservices, and receiving real-time webhooks.

DevRel Engineering

DevRel Engineering

Platform Architect • Published Sep 10, 2026

Executive Overview

The Mixoop API is organized around REST and GraphQL paradigms. All API requests must be served over HTTPS with valid API bearer tokens.

1. Authentication & Bearer Tokens

Pass your secret API key in the request header as `Authorization: Bearer mx_sk_live_...`. Keep API keys secure and never expose live secret keys in client-side repositories.
bash
curl -X GET "https://api.mixoop.com/v1/services" \
  -H "Authorization: Bearer mx_sk_live_abc123xyz" \
  -H "Content-Type: application/json"

2. Core REST Endpoint Reference

- `GET /v1/services`: List available company microservices - `POST /v1/workflows/trigger`: Execute an async workflow run - `GET /v1/agents/status/:id`: Poll execution state for autonomous agents - `POST /v1/documents/parse`: Send file binary for FormFlow NLP extraction

3. GraphQL Gateway Usage

For complex nested resource requests, query the GraphQL endpoint at `https://api.mixoop.com/graphql`:
graphql
query GetWorkspaceOverview {
  workspace(id: "ws_live_01") {
    name
    membershipStatus
    activeAgents {
      id
      name
      status
      lastExecutionTime
    }
  }
}

4. Verifying Webhook Signatures

Mixoop sends HMAC SHA-256 signatures in the `X-Mixoop-Signature` header to prevent spoofing. Verify signature hashes before accepting incoming event payloads.

Key Takeaway & Summary

Integrate Mixoop robustly with standard SDK libraries available for Node.js, Python, Go, and Java.

Related Resources

Continue exploring technical guides and templates

Guide

Building Autonomous AI Agents with Mixoop ProcessOS

A comprehensive step-by-step masterclass on orchestrating multi-model AI agents, defining custom triggers, and automating complex enterprise workflows.

Read Guide
Guide

FormFlow NLP & Intelligent Document Processing

Learn how to leverage FormFlow to extract structured JSON data from messy PDFs, images, and user inputs using vision-language models.

Read Guide
Template

Enterprise HRMS & Onboarding Automation Blueprint

Ready-to-deploy workflow template for automating employee onboarding, document verification, role assignment, and access provisioning.

Read Guide