Skip to content

Get a report's Distribution Kit

GET
/v1/reports/{slug}/kit
curl --request GET \
--url https://api.recomention.com/v1/reports/example/kit \
--header 'Authorization: Bearer <token>'

Markdown files for your own agent, built from a finished paid report.

slug
required
string

The kit.

Media typeapplication/json
object
kit
required
object
slug
required
string
brand
required
string
domain
required
string
simulated
required
boolean
files
required
Array<object>
object
path
required
string
content
required
string

Example generated

{
"kit": {
"slug": "example",
"brand": "example",
"domain": "example",
"simulated": true,
"files": [
{
"path": "example",
"content": "example"
}
]
}
}

Missing, malformed, unknown or revoked API key.

Media typeapplication/json
object
error
required

What went wrong, in plain words. Never repeats a submitted secret.

string
fields

Request fields to fix (400).

Array<string>
retryAfterSeconds

Seconds to wait before retrying (429).

integer
>= -9007199254740991 <= 9007199254740991
limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string
status

The report’s status, when it explains the refusal (409).

string

Example generated

{
"error": "example",
"fields": [
"example"
],
"retryAfterSeconds": 1,
"limit": "example",
"status": "example"
}

Not allowed for this account or report.

Media typeapplication/json
object
error
required

What went wrong, in plain words. Never repeats a submitted secret.

string
fields

Request fields to fix (400).

Array<string>
retryAfterSeconds

Seconds to wait before retrying (429).

integer
>= -9007199254740991 <= 9007199254740991
limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string
status

The report’s status, when it explains the refusal (409).

string

Example generated

{
"error": "example",
"fields": [
"example"
],
"retryAfterSeconds": 1,
"limit": "example",
"status": "example"
}

Not found. Someone else’s report answers the same as a missing one.

Media typeapplication/json
object
error
required

What went wrong, in plain words. Never repeats a submitted secret.

string
fields

Request fields to fix (400).

Array<string>
retryAfterSeconds

Seconds to wait before retrying (429).

integer
>= -9007199254740991 <= 9007199254740991
limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string
status

The report’s status, when it explains the refusal (409).

string

Example generated

{
"error": "example",
"fields": [
"example"
],
"retryAfterSeconds": 1,
"limit": "example",
"status": "example"
}

Not in a state that allows this yet.

Media typeapplication/json
object
error
required

What went wrong, in plain words. Never repeats a submitted secret.

string
fields

Request fields to fix (400).

Array<string>
retryAfterSeconds

Seconds to wait before retrying (429).

integer
>= -9007199254740991 <= 9007199254740991
limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string
status

The report’s status, when it explains the refusal (409).

string

Example generated

{
"error": "example",
"fields": [
"example"
],
"retryAfterSeconds": 1,
"limit": "example",
"status": "example"
}

Rate limited. Wait Retry-After seconds.

Media typeapplication/json
object
error
required

What went wrong, in plain words. Never repeats a submitted secret.

string
fields

Request fields to fix (400).

Array<string>
retryAfterSeconds

Seconds to wait before retrying (429).

integer
>= -9007199254740991 <= 9007199254740991
limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string
status

The report’s status, when it explains the refusal (409).

string

Example generated

{
"error": "example",
"fields": [
"example"
],
"retryAfterSeconds": 1,
"limit": "example",
"status": "example"
}
Retry-After
integer

Seconds to wait.

RateLimit-Limit
integer

Requests allowed in the window.

RateLimit-Remaining
integer

Requests left in the window (0 on a 429).

RateLimit-Reset
integer

Seconds until the window resets.

A dependency is briefly unavailable. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

What went wrong, in plain words. Never repeats a submitted secret.

string
fields

Request fields to fix (400).

Array<string>
retryAfterSeconds

Seconds to wait before retrying (429).

integer
>= -9007199254740991 <= 9007199254740991
limit

Which plan limit refused a start: plan, projects, reportsPerMonth, perDay, concurrent.

string
status

The report’s status, when it explains the refusal (409).

string

Example generated

{
"error": "example",
"fields": [
"example"
],
"retryAfterSeconds": 1,
"limit": "example",
"status": "example"
}
Retry-After
integer

Seconds to wait.