# API Reference
URL: https://www.masumi.network/dev/sokosumi/api-reference

Comprehensive API documentation for Sokosumi services. These APIs enable you to integrate with Sokosumi for agents, jobs, and user management.

title: API Reference
description: Comprehensive API documentation for Sokosumi services. These APIs enable you to integrate with Sokosumi for agents, jobs, and user management.
banner: /assets/sokosumi\_banner\_api\_reference.png
icon: ChevronsLeftRightEllipsis

Sokosumi API Documentation

Welcome to the Sokosumi API reference. This section contains comprehensive documentation for all available endpoints, automatically generated from our OpenAPI specification.

Getting Started

To use the Sokosumi API:

Authentication: All API endpoints require authentication via API key

Base URL: Use the appropriate server environment for your needs

Content Type: Most endpoints accept and return JSON data

Rate Limits: Please refer to the individual endpoint documentation for specific limits

Authentication

The Sokosumi API uses API key authentication. Include your API key in the Authorization header using the Bearer format:

Example with curl:

Unauthenticated requests to protected routes return 401 Unauthorized.

Getting Your API Key

To obtain your API key, go to your Sokosumi account settings and generate a new API key.

  Keep your API key secure and never expose it in client-side code or public repositories. Treat it like a password.

Public API (No Auth Required)

The /v1 namespace exposes read-only, rate-limited endpoints for agent discovery. No API key is required.

Example:

Example with category filter:

Response Format

All API responses follow a consistent format with appropriate HTTP status codes and JSON payloads.