API Documentation

Comprehensive RESTful API documentation for integrating with Cashilly platform. Build powerful applications with our robust APIs and SDKs.

Get Started Browse Endpoints

Quick Start

Get up and running in minutes

1. Get API Key

Generate API Key →

2. Make Request

Use your API key to make authenticated requests

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.cashilly.com/v1/projects

3. Build & Scale

Integrate with our SDKs and scale your application

View SDKs →

API Endpoints

Comprehensive reference for all API endpoints

GET/api/v1/projects

Retrieve all projects for the authenticated user

Parameters

limit

integer

Number of projects to return (max 100)

offset

integer

Number of projects to skip

status

string

Filter by project status

Example

Request:

GET /api/v1/projects?limit=10&status=active

Response:

{
  "projects": [
    {
      "id": "proj_123",
      "name": "Image Classification Dataset",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "total_tasks": 1000,
      "completed_tasks": 750
    }
  ],
  "total": 1,
  "limit": 10,
  "offset": 0
}

POST/api/v1/projects

Create a new annotation project

Parameters

name

stringRequired

Project name

description

string

Project description

annotation_type

stringRequired

Type of annotation (image, text, audio)

guidelines

stringRequired

Annotation guidelines

Example

Request:

POST /api/v1/projects

Response:

{
  "id": "proj_456",
  "name": "Object Detection Dataset",
  "status": "created",
  "created_at": "2024-01-15T11:00:00Z",
  "annotation_type": "image",
  "total_tasks": 0
}

GET/api/v1/tasks

Retrieve tasks for a specific project

Parameters

project_id

stringRequired

Project ID

status

string

Filter by task status

limit

integer

Number of tasks to return

Example

Request:

GET /api/v1/tasks?project_id=proj_123&status=pending&limit=5

Response:

{
  "tasks": [
    {
      "id": "task_789",
      "project_id": "proj_123",
      "status": "pending",
      "data": {
        "image_url": "https://example.com/image1.jpg"
      },
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 250,
  "limit": 5
}

POST/api/v1/tasks/{task_id}/annotations

Submit annotations for a task

Parameters

task_id

stringRequired

Task ID (in URL path)

annotations

arrayRequired

Array of annotation objects

confidence

float

Confidence score (0-1)

Example

Request:

POST /api/v1/tasks/task_789/annotations

Response:

{
  "id": "ann_101",
  "task_id": "task_789",
  "status": "submitted",
  "submitted_at": "2024-01-15T12:00:00Z",
  "quality_score": 0.95
}

Authentication

Secure your API requests with multiple authentication methods

API Key

Medium Security

Simple API key authentication for basic integrations

Use Case

Server-to-server communication

Example:

Authorization: Bearer sk_live_1234567890abcdef

OAuth 2.0

High Security

Industry-standard OAuth 2.0 for secure user authentication

Use Case

User-facing applications

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

JWT

High Security

JSON Web Tokens for stateless authentication

Use Case

Microservices and distributed systems

Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Official SDKs

Use our official SDKs for faster integration

Python

v2.1.0

Official Python SDK with async support

Features

Async/awaitType hintsError handlingRetry logic

Install:

pip install cashilly-sdk

View Documentation

JavaScript

v1.8.0

Node.js and browser-compatible SDK

Features

Promise-basedBrowser supportTypeScriptWebhooks

Install:

npm install @cashilly/sdk

View Documentation

Go

v1.2.0

High-performance Go SDK

Features

Context supportConcurrent requestsStruct tagsError wrapping

Install:

go get github.com/cashilly/sdk-go

View Documentation

PHP

v1.5.0

PHP SDK with Laravel integration

Features

Laravel supportPSR-7Guzzle HTTPError handling

Install:

composer require cashilly/sdk

View Documentation

Rate Limits

Fair usage limits to ensure platform stability

Free

1,000/month

Burst: 10/minute

Perfect for testing and small projects

View Pricing

Pro

100,000/month

Burst: 100/minute

Ideal for production applications

View Pricing

Enterprise

Unlimited

Burst: 1,000/minute

Custom limits for high-volume usage

View Pricing

Ready to Start Building?

Get your API key and start integrating with Cashilly today

Get API Key View Integration Guides