Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ReqRes Agent Sandbox API

Endpoints designed for AI coding agents. Cursor pagination, deeply nested resources, deliberate error scenarios, deterministic seeded fixtures.

ReqRes Agent Sandbox API is one of 6 APIs that ReqRes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 16 JSON Schema definitions.

Tagged areas include Agent Sandbox. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an engineering blog, a JSON-LD context, and 16 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2.1.0.

Requests are made against 2 base URLs: https://reqres.in, http://localhost:8000.

7 operations 7 paths 6 schemas 6 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.1.0
Base URL
https://reqres.in/
Authentication
API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

ReqRes Agent Sandbox API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (session_token) (BearerAuth).

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 6 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Agent Sandbox 7

Endpoints designed for AI coding agents. Cursor pagination, deeply nested resources, deliberate error scenarios, deterministic seeded fixtures.

GET
/agent/v1/health
ReqRes Agent Sandbox Health Probe
agentHealth → 200
GET
/agent/v1/users
ReqRes List Agent Users (cursor Pagination)
agentListUsers 4 params → 200
GET
/agent/v1/users/{id}
ReqRes Get a Single Agent User with Optional Expansion
agentGetUser 2 params → 200400404
POST
/agent/v1/auth/login
ReqRes Agent Auth Login (with MFA Branch)
agentLogin body → 200400401422429
GET
/agent/v1/orders
ReqRes List Agent Orders (relational Data)
agentListOrders 4 params → 200400
GET
/agent/v1/scenarios
ReqRes List Training Scenarios
agentListScenarios → 200
GET
/agent/v1/scenarios/{scenario}
ReqRes Trigger a Deliberate Failure Scenario
agentScenario 1 param → 200206302401403404409413

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are AgentUser (10 properties), AgentPaginationMeta (6 properties), AgentErrorResponse (4 properties), AgentUserListResponse (2 properties). Each schema is shown below with its type and property counts.

AgentHealthResponse
object
1 property 1 required
AgentPaginationMeta
object
6 properties 6 required
AgentUser
object
10 properties 10 required
AgentUserListResponse
object
2 properties 2 required
AgentUserDetailResponse
object
1 property 1 required
AgentErrorResponse
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reqres-agent-sandbox-api-openapi.yml Raw ↑

Other APIs ReqRes publishes across the network.

ReqRes App Users API
ReqRes Authentication API
ReqRes Collections API
ReqRes Custom Endpoints API
ReqRes Legacy API