Yanok

API Reference

Yanok AI REST API v1 Documentation

REST API Version v1

Overview

The Yanok AI API provides programmatic access to the platform's workflow automation and AI agent capabilities.

Base URL

https://api.yanok.ai/v1

Content Type

application/json

Authentication

Bearer Token

Authentication

All API requests require a Bearer token. Include it in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Generate API keys from Settings → API Keys in your dashboard.

Endpoints

GET /pipelines

List Pipelines

Retrieve a paginated list of all pipelines accessible to the authenticated user.

Parameters

Name	In	Type	Required	Description
`page`	query	integer	No	Page number for pagination
`limit`	query	integer	No	Number of items per page

Responses

200 Success - Returns array of Pipeline objects

401 Unauthorized - Access token invalid or missing

GET /pipelines/{id}

Get Pipeline

Retrieve detailed information about a specific pipeline by its unique identifier.

Parameters

Name	In	Type	Required	Description
`id`	path	string (UUID)	Yes	Unique identifier of the pipeline

Responses

200 Success - Returns Pipeline object

401 Unauthorized - Access token invalid or missing

404 Not Found - Pipeline not found

Data Models

Pipeline Schema

Field	Type	Required	Description
`id`	string (UUID)	Yes	Unique identifier for the pipeline
`title`	string	No	Human-readable name of the pipeline
`description`	string	No	Detailed description of the pipeline's purpose
`account_id`	string	Yes	Account identifier owning this pipeline
`created_at`	string (ISO 8601)	Yes	Timestamp when pipeline was created
`updated_at`	string (ISO 8601)	Yes	Timestamp when pipeline was last updated
`trigger_key`	string	Yes	Unique key used to trigger pipeline execution

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Data Processing Pipeline",
  "description": "Automated data processing and transformation workflow",
  "account_id": "acc_987654321",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "trigger_key": "trigger_abc123xyz"
}

Error Handling

Code	Description	Type
200	OK - Request successful	success
201	Created - Resource created	success
401	Unauthorized - Invalid token	error
404	Not Found - Resource not found	error
500	Server Error - Internal error	error

Rate Limiting & Best Practices

The API enforces rate limits per plan tier. Monitor response headers for current usage.

Best Practices

Cache responses when possible
Use pagination for large datasets
Handle errors gracefully

For additional support or questions about the API, please contact our developer support team.