`ENDPOINT_OR_OBJECT_NAME`

One-sentence description of what this endpoint / object / service does.

Base URL: https://api.example.com/v1
Authentication: Bearer token — see Authentication

Endpoints

`GET /resource`

Short description.

Query Parameters

Parameter	Type	Required	Default	Description
`param`	`string`	Yes	—	What it controls.
`param`	`integer`	No	`10`	What it controls.

Response 200 OK


{
  "id": "string",
  "name": "string",
  "status": "active | inactive"
}

Error Codes

Code	Meaning
`400`	Bad request — missing or invalid parameter.
`401`	Unauthorized — check token.
`404`	Resource not found.

`POST /resource`

Short description.

Request Body (application/json)

Field	Type	Required	Description
`name`	`string`	Yes	Name of the resource. Max 128 chars.
`config`	`object`	No	Optional configuration block.

Example Request

cURL


curl -X POST https://api.example.com/v1/resource \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-resource"}'

Python


import requests
 
response = requests.post(
"https://api.example.com/v1/resource",
headers={"Authorization": f"Bearer {token}"},
json={"name": "my-resource"},
)
response.raise_for_status()
print(response.json())

PowerShell


Invoke-RestMethod `
  -Method POST `
  -Uri "https://api.example.com/v1/resource" `
  -Headers @{ Authorization = "Bearer $token" } `
  -ContentType "application/json" `
  -Body '{"name": "my-resource"}'

Response 201 Created


{
  "id": "abc123",
  "name": "my-resource",
  "createdAt": "2026-01-01T00:00:00Z"
}

Object Reference

`ResourceObject`

Property	Type	Description
`id`	`string`	Unique identifier. Read-only.
`name`	`string`	Display name. Max 128 chars.
`status`	`"active" \| "inactive"`	Current state.
`createdAt`	`string (ISO 8601)`	Creation timestamp. Read-only.

Was this page helpful?

ENDPOINT_OR_OBJECT_NAME

Endpoints

GET /resource

POST /resource