←back to manuals

Platform Manuals

While general documentation covers concepts and tutorials, manuals focus on the practical details of working with specific platform features and APIs. Each manual provides comprehensive information about a particular resource type, API endpoint, or operational procedure, with complete examples and parameter documentation.

Accessing the Manual Library

To retrieve the complete collection of available manuals:

Each manual entry includes:

  • id: Unique identifier for the manual
  • name: Manual title describing the covered topic
  • description: Summary of what the manual covers
  • category: Organizational category for grouping related manuals
  • tags: Keywords for discovering relevant manuals
  • index: Display order for organizing manuals logically
  • link: Direct link to the manual on the documentation site

Manual Organization

Manuals are organized by resource type and functionality:

  • Resource Manuals: Detailed guides for working with specific resources like bots, datasets, or integrations
  • API Manuals: Complete references for API endpoints with request/response examples
  • Feature Manuals: Operational guides for platform features like authentication, webhooks, or file handling
  • Integration Manuals: Step-by-step guides for connecting with external services

Manuals vs Documentation

Understanding the distinction helps you find the right information:

Documentation (Docs): Conceptual guides, tutorials, architectural overviews, and getting-started materials focused on learning and understanding.

Manuals: Procedural references, API specifications, parameter details, and operational guides focused on implementation and troubleshooting.

Use documentation when learning new concepts or planning implementations. Use manuals when implementing specific features or debugging issues.

Building with Manuals

The manual API enables several use cases:

  • Creating context-aware help systems that show relevant manuals
  • Building custom API documentation browsers
  • Training AI agents with platform-specific knowledge
  • Generating comprehensive API references
  • Creating offline documentation packages

Note: Like documentation, the list endpoint returns only metadata. Use the fetch endpoint to access full manual content. All manuals are kept up-to-date with the latest platform features and API changes.

Searching Manuals by Topic

When you need specific operational guidance or API details, semantic search helps you find the most relevant manuals quickly. The search understands the intent behind your query and returns manuals that best address your needs.

To search for manuals:

The search parameter accepts natural language descriptions of what you're trying to do or the information you need:

  • "creating a bot with custom backstory"
  • "uploading files to conversations"
  • "configuring webhook authentication"
  • "managing API rate limits"

The optional take parameter controls the maximum number of results (1-100, default is 10).

Search Result Details

Manual search results include:

  • score: Relevance score from similarity matching
  • excerpt: Most relevant text snippet from the manual
  • All standard metadata (category, tags, index, link)

Results are ranked by relevance, with the most applicable manuals appearing first. The excerpt shows you exactly which section of the manual matches your query, helping you quickly determine if it contains the information you need.

Optimizing Manual Searches

For best results:

  • Include the resource type or feature area in your query
  • Describe the specific operation or task you want to perform
  • Mention any relevant parameters or concepts
  • Use technical terminology when appropriate

For example, instead of searching for "data", search for "adding records to datasets" or "dataset record management". More specific queries return more targeted results.

Search Implementation

Manual search uses the same vector embedding technology as documentation search:

  • Pre-computed embeddings ensure fast response times
  • Cosine similarity scoring ranks results by relevance
  • Automatic re-indexing keeps search current with content updates
  • Typically returns results within 1-2 seconds

The search considers the entire manual content when computing similarity, including code examples, parameter descriptions, and operational notes. This ensures comprehensive coverage and helps you find specific technical details even when using general queries.

Tip: Review multiple search results even with high-scoring top matches. Related manuals often provide complementary information or alternative approaches that may better suit your specific use case.

Retrieving Complete Manual Content

To access the full content of a specific manual with all details, examples, and reference information:

Replace {manualId} with the manual identifier. For example, to fetch the datasets manual:

Manual Content Structure

The fetch response includes:

  • content: Full markdown content with all sections, examples, and details
  • Metadata: name, description, category, tags, index
  • link: Link to the official manual page
  • Timestamps: createdAt and updatedAt

Using Manual Content

The content field contains comprehensive markdown documentation that typically includes:

  • Feature overviews: What the feature does and why it's useful
  • Endpoint documentation: Complete API reference with HTTP methods and paths
  • Parameter details: Descriptions, types, and constraints for all parameters
  • Code examples: Working examples in multiple formats (HTTP, JavaScript, etc.)
  • Response schemas: Expected response structures with field descriptions
  • Usage notes: Important considerations, limitations, and best practices

You can process this content to:

  • Build custom API documentation viewers
  • Extract specific sections programmatically
  • Generate SDK documentation
  • Create interactive API explorers
  • Train AI assistants with platform knowledge
  • Generate PDF reference materials

Manual Generation Process

ensuring they stay synchronized with actual implementation. This means:

  • Documentation reflects the current API behavior
  • Examples use real, tested code patterns
  • Parameter descriptions match actual validation rules
  • Updates happen automatically with code changes

The content is clean markdown without frontmatter, ready for parsing and display. All formatting, code blocks, headings, and links are preserved.

Error Handling

A 404 response indicates the manual wasn't found. This can occur if:

  • The manual ID is incorrect or misspelled
  • The manual has been deprecated or merged with another
  • There's an inconsistency between index and content storage

Handle 404s gracefully by suggesting alternatives or searching for related manuals using the search endpoint.

Important: Manuals represent the definitive API reference for the platform. When there's a discrepancy between other documentation sources and manuals, the manual content should be considered authoritative as it's generated directly from the implementation.

manualsguidesapi-referencehow-to