Skip to content

Guides

This section provides step-by-step guides for common workflows using the Madevo API.

Unlike the API Reference, these guides focus on how to accomplish real tasks, not just individual endpoints.

What you will find here

The guides walk you through practical use cases such as:

  • Uploading and creating a datasource
  • Inserting data into a datasource
  • Starting and using the assistant
  • Streaming assistant responses
  • Creating and scheduling agent tasks

Each guide includes:

  • The full workflow
  • Required endpoints
  • Example requests
  • Important notes and best practices

When to use guides vs API reference

Use Guides when:

  • You want to complete a task end-to-end
  • You are new to the API
  • You need to understand how endpoints work together

Use API Reference when:

  • You need exact request/response details
  • You are implementing a specific endpoint
  • You already understand the workflow

If you are new to the API, follow this order:

  1. Upload and create a datasource
  2. Insert or query data
  3. Start an assistant conversation
  4. Stream assistant responses
  5. Create and schedule an agent

Available guides

  • Upload and Create Datasource
    Learn how to upload a file and define a datasource

  • Insert Data into Datasource
    Add structured data directly into an existing datasource

  • Start an Assistant Conversation
    Create a conversation and query your data using natural language

  • Stream Assistant Responses
    Use WebSocket to receive real-time assistant output

  • Schedule an Agent Task
    Automate recurring analysis using agents

Notes

  • Guides assume you are already authenticated
  • All examples use Bearer token authentication
  • Replace placeholder values (e.g. <jwt>, <id>) with real values

Next steps

Choose a guide from the list and follow it step by step to get started quickly.