Skip to main content
Every Everflow API endpoint is defined in OpenAPI 3.0.3 YAML specification files. These specs are the source of truth for this documentation and can be loaded directly into AI assistants, code generators, and automation frameworks. For a full map of this entire documentation site optimized for AI context, use the llms.txt file.

​
What’s included in the specs

Each specification file contains:
  • Endpoint paths with HTTP methods
  • Request body schemas with property types, descriptions, and required fields
  • Response schemas with full object structures
  • Example payloads for request bodies
  • Path and query parameters with types and descriptions

​
Using specs with AI assistants

​
Claude Projects

  1. Create a new Claude Project
  2. Upload the relevant OpenAPI YAML files to the project knowledge
  3. Ask Claude to generate API calls, write integration scripts, or explain endpoint behavior

​
Custom GPTs

  1. Go to ChatGPT and create a new GPT
  2. Upload the spec files under Knowledge
  3. Instruct the GPT to use the Everflow API specs to answer questions and generate code

​
Cursor / VS Code

The spec files are already integrated into these docs. Use the Open in Cursor or Open in VS Code buttons on any endpoint page to load the spec directly into your editor with AI context.

​
Using specs with agent frameworks

​
LangChain

from langchain_community.agent_toolkits.openapi import planner
from langchain_community.utilities.requests import TextRequestsWrapper

# Load the OpenAPI spec
import yaml
with open("reporting-aggregated.yaml") as f:
    spec = yaml.safe_load(f)

# Create tools from the spec and use them in your agent chain

​
Generic HTTP agent

Any framework that supports OpenAPI tool definitions can use the specs directly. The key fields an agent needs:
FieldLocation in specExample
Base URLservers[0].urlhttps://api.eflow.team/v1
AuthenticationsecurityX-Eflow-API-Key header
Endpointspaths/networks/reporting/entity/table
Request formatrequestBody.content.application/json.schemaJSON schema with types
Required fieldsschema.required[from, to, timezone_id, currency_id, columns]
ExamplesrequestBody.content.application/json.examplePre-filled JSON payloads

​
Spec files by API

The specifications are organized by resource:

​
Network API

ResourceSpec fileKey endpoints
Reporting: Aggregatedreporting-aggregated.yamlEntity tables, summaries, variance, post-conversions, MTTI
Reporting: Clicksreporting-clicks.yamlClick details, click stream
Reporting: Conversionsreporting-conversions.yamlSearch, create, update, upload conversions
Reporting: Dashboardreporting-dashboard.yamlDashboard summary
Reporting: Eventsreporting-events.yamlPost-conversion events per transaction
Reporting: Impressionsreporting-impressions.yamlImpression stream, invalid clicks
Reporting: On-Holdreporting-onhold.yamlOn-hold conversion search and management
Reporting: Postbacksreporting-postbacks.yamlAffiliate and advertiser pixel logs
Reporting: Transactionsreporting-transactions.yamlTransaction overview and flowchart
Reporting: Adjustmentsreporting-adjustments.yamlAdjustments and refunds
Reporting: Capsreporting-caps.yamlOffer, offer group, and custom caps
Reporting: Miscreporting-misc.yamlCurrency rates, referrals
Reporting: Exportsreporting-exports.yamlCSV/JSON exports for reports
Offersoffers.yamlCreate, update, list, get offers
Offer Extrasoffers-extras.yamlBulk edit, copy, tracking URLs, payout/revenue config
Affiliatesaffiliates.yamlCreate, update, list, get affiliates
Advertisersadvertisers.yamlCreate, update, list, get advertisers
Creativescreatives.yamlCreate, update, list creatives
Smart Linkssmart-links.yamlCreate, update, list smart links
Offer URLsoffer-urls.yamlCreate, update, list offer URLs
Offer Groupsoffer-groups.yamlCreate, update, list offer groups
Coupon Codescoupon-codes.yamlCreate, update, list coupon codes
Partner Postbackspartner-postbacks.yamlCreate, update, list postbacks
Custom Payout/Revenuecustom-payout-revenue.yamlCustom partner-level payouts
Custom Capscustom-caps.yamlCustom partner-level caps
Custom Scrub Ratescustom-scrub-rates.yamlCustom throttle settings
Traffic Controlstraffic-controls.yamlWhitelist/blacklist rules
Webhookswebhooks.yamlCreate and manage webhooks

​
Affiliate API

ResourceSpec fileKey endpoints
Offersaffiliate-offers.yamlList offers, generate tracking URLs
Reportingaffiliate-reporting.yamlAggregated data, conversions, clicks
Postbacksaffiliate-postbacks.yamlCreate and manage postbacks

​
Advertiser API

ResourceSpec fileKey endpoints
Offersadvertiser-offers.yamlList offers
Reportingadvertiser-reporting.yamlEntity reporting, conversions