Test Configuration

NoteFor security, tokens are stored locally in your browser.

Clear Token?

"" is cleared from this browser. The token itself keeps working; we're only forgetting it here, so you'll need to paste it in again to keep testing.

Feedback

Manage user feedback

GET/api/v0/feedback

List feedback

Retrieve a paginated list of feedback with optional filtering, sorting, and search.

URL parameters

Which page to return. Starts at 1.

How many results to return per page.

Which field to sort the results by.

Which direction to sort the results in.

Filter the results to feedback that needs human review, or send false for the feedback that does not.

Filter the results to feedback that landed in no buffer after routing finished.

Filter the results to feedback assigned to this buffer, named by its id or its slug.

Filter the results to feedback matching this text in their title or description.

Response
200A successful response

The feedback that matched the query.

idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

titlestring | null

A short summary of the feedback.

descriptionstring

The full text of the feedback or bug report.

needs_reviewboolean

Whether this feedback needs human review.

submitted_bystring | null

A free-form identifier supplied at creation for whoever submitted this feedback, such as your own user id or an anonymous token. Treated as an opaque string and never parsed.

routing_statusstring
"pending"
"routed"
"skipped"
"failed"

Where this feedback is in routing.

  • pending: routing has not finished yet. Read GET /api/v0/feedback/{feedback_id} again for the result.
  • routed: routing finished. Fetch GET /api/v0/feedback/{feedback_id}/buffers for the buffers it chose; an empty list means nothing matched, which is a result rather than an error.
  • skipped: routing did not run, because AI routing is turned off for your organization, or because your organization has no buffers and does not create them automatically.
  • failed: routing could not be completed. GET /api/v0/feedback/{feedback_id}/buffers shows only the buffers you assigned by hand. Run routing again from the feedback's page.
created_atstring (date-time)

The ISO 8601 timestamp when the feedback was created.

updated_atstring (date-time)

The ISO 8601 timestamp when the feedback was last modified.

Also carries search when the request used the search parameter.

pageinteger

The page this response came from. Starts at 1.

limitinteger

The number of items per page.

totalinteger

The total number of items across all pages.

total_pagesinteger

The total number of pages.

nextstring | null

The path to the next page, carrying the same filters, or null when you are on the last page. Request it as-is rather than building your own query string.

prevstring | null

The path to the previous page, carrying the same filters, or null on page 1.

The links for the collection itself, carrying the filters and page from this request.

Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

itemsobject

The links for each item in data, keyed by that item's id.

The search metadata for a list response. Present only when the search query parameter was supplied.

querystring

The search text you sent.

resultsobject

The per-result search data keyed by the id of each item in data. Every item in data has an entry; empty when nothing matched.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404The buffer_id filter names no buffer in your organization, by either id or slug (buffer-not-found).

The buffer_id filter names no buffer in your organization, by either id or slug (buffer-not-found).

typeany
https://inputbuffer.io/docs/api/problems/buffer-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback
POST/api/v0/feedback

Create a piece of feedback

Create a new piece of feedback. The response comes back before routing has decided which buffers the feedback belongs in, so new feedback has a routing_status of pending and no buffers yet. Read GET /api/v0/feedback/{feedback_id} for the result once it is done, or list with unassigned=true for the feedback that finished routing without matching a buffer.

Request body*

A short summary of the feedback (1–500 characters).

The full text of the feedback or bug report (1–5000 characters). Content is sent to third-party AI services for classification and search; do not include personal information, credentials, or production secrets.

A free-form identifier for whoever submitted this feedback, such as your own user id or an anonymous token. Treated as an opaque string and never parsed.

targets(array, max 10)

The targets to associate with this feedback, so you can attach the page, endpoint, or command the feedback is about in the same call that submits it. Each item needs a type and its metadata. A matching target is reused if one exists, and created if not.

The response does not include the targets, so read them back at GET /api/v0/feedback/{feedback_id}/targets.

No targets added yet.

Response
201The feedback that was created

A single piece of feedback. Every endpoint that returns feedback returns the same fields.

idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

titlestring | null

A short summary of the feedback.

descriptionstring

The full text of the feedback or bug report.

needs_reviewboolean

Whether this feedback needs human review.

submitted_bystring | null

A free-form identifier supplied at creation for whoever submitted this feedback, such as your own user id or an anonymous token. Treated as an opaque string and never parsed.

routing_statusstring
"pending"
"routed"
"skipped"
"failed"

Where this feedback is in routing.

  • pending: routing has not finished yet. Read GET /api/v0/feedback/{feedback_id} again for the result.
  • routed: routing finished. Fetch GET /api/v0/feedback/{feedback_id}/buffers for the buffers it chose; an empty list means nothing matched, which is a result rather than an error.
  • skipped: routing did not run, because AI routing is turned off for your organization, or because your organization has no buffers and does not create them automatically.
  • failed: routing could not be completed. GET /api/v0/feedback/{feedback_id}/buffers shows only the buffers you assigned by hand. Run routing again from the feedback's page.
created_atstring (date-time)

The ISO 8601 timestamp when the feedback was created.

updated_atstring (date-time)

The ISO 8601 timestamp when the feedback was last modified.

The response metadata for a single resource.

The links for the resource in data.

Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

relatedobject

The links for the objects embedded in this resource, keyed by the field each one sits at. A value is null when the embedded object has nothing to link to. {} when the resource embeds nothing.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

402The organization has reached its lifetime feedback limit (usage-limit-reached).

The organization has reached its lifetime feedback limit (usage-limit-reached).

typeany
https://inputbuffer.io/docs/api/problems/usage-limit-reached
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

403You are not permitted to create feedback (forbidden); a full-access token was used from a browser (widget-token-restricted); or a widget token's origin isn't allowlisted (forbidden-origin).

You are not permitted to create feedback (forbidden); a full-access token was used from a browser (widget-token-restricted); or a widget token's origin isn't allowlisted (forbidden-origin).

typeany
https://inputbuffer.io/docs/api/problems/forbidden
https://inputbuffer.io/docs/api/problems/widget-token-restricted
https://inputbuffer.io/docs/api/problems/forbidden-origin
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unsupported-media-type

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

422A required field is missing or a field value is invalid. Check field.

A required field is missing or a field value is invalid. Check field.

typestring (uri)
https://inputbuffer.io/docs/api/problems/missing-required-field
https://inputbuffer.io/docs/api/problems/invalid-field-value

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

429Too many requests.

Too many requests.

typestring (uri)
https://inputbuffer.io/docs/api/problems/rate-limited

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback
{}
GET/api/v0/feedback/{feedback_id}

Get a piece of feedback

Get a single piece of feedback by its identifier.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Response
200A successful response

A single piece of feedback. Every endpoint that returns feedback returns the same fields.

idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

titlestring | null

A short summary of the feedback.

descriptionstring

The full text of the feedback or bug report.

needs_reviewboolean

Whether this feedback needs human review.

submitted_bystring | null

A free-form identifier supplied at creation for whoever submitted this feedback, such as your own user id or an anonymous token. Treated as an opaque string and never parsed.

routing_statusstring
"pending"
"routed"
"skipped"
"failed"

Where this feedback is in routing.

  • pending: routing has not finished yet. Read GET /api/v0/feedback/{feedback_id} again for the result.
  • routed: routing finished. Fetch GET /api/v0/feedback/{feedback_id}/buffers for the buffers it chose; an empty list means nothing matched, which is a result rather than an error.
  • skipped: routing did not run, because AI routing is turned off for your organization, or because your organization has no buffers and does not create them automatically.
  • failed: routing could not be completed. GET /api/v0/feedback/{feedback_id}/buffers shows only the buffers you assigned by hand. Run routing again from the feedback's page.
created_atstring (date-time)

The ISO 8601 timestamp when the feedback was created.

updated_atstring (date-time)

The ISO 8601 timestamp when the feedback was last modified.

The response metadata for a single resource.

The links for the resource in data.

Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

relatedobject

The links for the objects embedded in this resource, keyed by the field each one sits at. A value is null when the embedded object has nothing to link to. {} when the resource embeds nothing.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404No feedback matches this ID in your organization (feedback-not-found).

No feedback matches this ID in your organization (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback/
PATCH/api/v0/feedback/{feedback_id}

Update a piece of feedback

Partially update existing feedback using RFC 7396 JSON Merge Patch. Omit a field to leave it unchanged, send a value to set it, send null to remove it. Arrays replace wholesale.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Request body*

The updated summary of the feedback. Send null to clear it.

The updated full text of the feedback.

Whether this feedback needs human review.

The updated submitter identifier: an email address, your own user id, or an anonymous token. Send null to clear it.

Response
200Updated

A single piece of feedback. Every endpoint that returns feedback returns the same fields.

idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

titlestring | null

A short summary of the feedback.

descriptionstring

The full text of the feedback or bug report.

needs_reviewboolean

Whether this feedback needs human review.

submitted_bystring | null

A free-form identifier supplied at creation for whoever submitted this feedback, such as your own user id or an anonymous token. Treated as an opaque string and never parsed.

routing_statusstring
"pending"
"routed"
"skipped"
"failed"

Where this feedback is in routing.

  • pending: routing has not finished yet. Read GET /api/v0/feedback/{feedback_id} again for the result.
  • routed: routing finished. Fetch GET /api/v0/feedback/{feedback_id}/buffers for the buffers it chose; an empty list means nothing matched, which is a result rather than an error.
  • skipped: routing did not run, because AI routing is turned off for your organization, or because your organization has no buffers and does not create them automatically.
  • failed: routing could not be completed. GET /api/v0/feedback/{feedback_id}/buffers shows only the buffers you assigned by hand. Run routing again from the feedback's page.
created_atstring (date-time)

The ISO 8601 timestamp when the feedback was created.

updated_atstring (date-time)

The ISO 8601 timestamp when the feedback was last modified.

The response metadata for a single resource.

The links for the resource in data.

Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

relatedobject

The links for the objects embedded in this resource, keyed by the field each one sits at. A value is null when the embedded object has nothing to link to. {} when the resource embeds nothing.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

403The token is valid but not permitted to perform this action.

The token is valid but not permitted to perform this action.

typestring (uri)
https://inputbuffer.io/docs/api/problems/forbidden
https://inputbuffer.io/docs/api/problems/forbidden-origin
https://inputbuffer.io/docs/api/problems/widget-token-restricted
https://inputbuffer.io/docs/api/problems/admin-required

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404No feedback matches this ID in your organization (feedback-not-found).

No feedback matches this ID in your organization (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unsupported-media-type

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

422A required field is missing or a field value is invalid. Check field.

A required field is missing or a field value is invalid. Check field.

typestring (uri)
https://inputbuffer.io/docs/api/problems/missing-required-field
https://inputbuffer.io/docs/api/problems/invalid-field-value

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback/
{}
DELETE/api/v0/feedback/{feedback_id}

Delete a piece of feedback

Permanently delete a piece of feedback. We can't bring it back.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Response
204Deleted. No response body.

No response body

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

403The token is valid but not permitted to perform this action.

The token is valid but not permitted to perform this action.

typestring (uri)
https://inputbuffer.io/docs/api/problems/forbidden
https://inputbuffer.io/docs/api/problems/forbidden-origin
https://inputbuffer.io/docs/api/problems/widget-token-restricted
https://inputbuffer.io/docs/api/problems/admin-required

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404feedback_id isn't a validly formed identifier (feedback-not-found).

feedback_id isn't a validly formed identifier (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unsupported-media-type

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback/
GET/api/v0/feedback/{feedback_id}/buffers

List the buffers for a piece of feedback

The buffers routing put this feedback in, plus any you assigned by hand. They all come back in a single response. Buffers you have deleted are left out, matching GET /api/v0/buffers.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Response
200The buffers this feedback is assigned to, newest assignment first

The buffers this feedback is assigned to. Empty when the classifier found no match, which is a result rather than an error.

idstring | null

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

namestring

The display name of the buffer.

slugstring | null

The URL-safe identifier for the buffer.

The response metadata for a list that returns everything at once, so there is no pagination.

The links for the list itself.

Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

itemsobject

The links for each item in data, keyed by that item's id.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404No feedback matches this ID in your organization (feedback-not-found).

No feedback matches this ID in your organization (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback//buffers
GET/api/v0/feedback/{feedback_id}/targets

List the targets for a piece of feedback

The targets this feedback points at.

Creating feedback accepts targets but does not return them, so this is where you read what your submission resolved to. Two targets of the same type and metadata are the same target, so the one you get back may be a target that already existed.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Response
200The targets this feedback points at, newest first

The targets this feedback points at. Empty when none were supplied at creation.

idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

typestring
"rest_endpoint"
"documentation"
"cli_command"

Which kind of surface this target identifies. Immutable after create.

display_namestring

A human-readable label, derived from metadata when the target was created.

metadataone of 3

The details identifying the target. Which fields it carries depends on type; the shape for each type is listed below.

One of the following:

Rest Endpoint Metadata
methodstring

The HTTP method (e.g. GET, POST).

pathstring

The API endpoint path.

hoststring

The hostname of the API (e.g. api.example.com).

api_versionstring

The API version string (e.g. v1).

Documentation Metadata
page_urlstring

The URL of the documentation page.

section_headingstring

The section heading within the page.

doc_versionstring

The documentation version string.

Cli Command Metadata
commandstring

The CLI command name.

subcommandstring

The subcommand path, which may be multi-word (e.g. "container run").

cli_versionstring

The CLI version string.

The documented flags and args, e.g. ["--rm", "--network"].

The response metadata for a list that returns everything at once, so there is no pagination.

The links for the list itself.

Where to call this resource in this API, for example /api/v0/feedback/8x7k2mN.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

Where a person can open this resource in InputBuffer, for example /o/yoyodyne/feedback/8x7k2mN. Use it to link a user straight to the page. web is null when the resource has no page of its own.

selfstring

The path to this resource. It starts with a / and carries no domain, so join it to https://inputbuffer.io for a full URL.

itemsobject

The links for each item in data, keyed by that item's id.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404No feedback matches this ID in your organization (feedback-not-found).

No feedback matches this ID in your organization (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback//targets
GET/api/v0/feedback/{feedback_id}/notes

List the notes on a piece of feedback

Retrieve all the notes on a piece of feedback.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Response
200A successful response

All notes on this feedback, ordered oldest first.

idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

feedback_idstring

The id of the feedback this note belongs to.

contentstring

The text content of the note.

typestring
"note"
"activity"

note for manual comments, activity for system-generated events.

author_idstring

The id of the team member who wrote this note.

author_namestring | null

The display name of the note author, for printing a timeline without a second request. null when that person no longer has an account.

created_atstring (date-time)

The ISO 8601 timestamp when the note was created.

metaobject

The response metadata. Always present, and empty here because the response names no resource that could be linked to.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404No feedback matches this ID in your organization (feedback-not-found).

No feedback matches this ID in your organization (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback//notes
POST/api/v0/feedback/{feedback_id}/notes

Add a note

Add an internal note to a piece of feedback.

URL parameters

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

Request body*

The text content of the note.

Response
201The note that was added
idstring

A unique identifier for a resource. Treat it as an opaque string: don't parse it or build your own.

feedback_idstring

The id of the feedback this note belongs to.

contentstring

The text content of the note.

typestring
"note"
"activity"

note for manual comments, activity for system-generated events.

author_idstring

The id of the team member who wrote this note.

author_namestring | null

The display name of the note author, for printing a timeline without a second request. null when that person no longer has an account.

created_atstring (date-time)

The ISO 8601 timestamp when the note was created.

metaobject

The response metadata. Always present, and empty here because the response names no resource that could be linked to.

401The API token is missing, malformed, or revoked.

The API token is missing, malformed, or revoked.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unauthorized
https://inputbuffer.io/docs/api/problems/invalid-token-format
https://inputbuffer.io/docs/api/problems/invalid-token

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

403The token is valid but not permitted to perform this action.

The token is valid but not permitted to perform this action.

typestring (uri)
https://inputbuffer.io/docs/api/problems/forbidden
https://inputbuffer.io/docs/api/problems/forbidden-origin
https://inputbuffer.io/docs/api/problems/widget-token-restricted
https://inputbuffer.io/docs/api/problems/admin-required

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

404No feedback matches this ID in your organization (feedback-not-found).

No feedback matches this ID in your organization (feedback-not-found).

typeany
https://inputbuffer.io/docs/api/problems/feedback-not-found
titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

415The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

The request body wasn't sent as application/json (or application/merge-patch+json, which PATCH also accepts). Set the Content-Type header and send a JSON-encoded body.

typestring (uri)
https://inputbuffer.io/docs/api/problems/unsupported-media-type

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

422A required field is missing or a field value is invalid. Check field.

A required field is missing or a field value is invalid. Check field.

typestring (uri)
https://inputbuffer.io/docs/api/problems/missing-required-field
https://inputbuffer.io/docs/api/problems/invalid-field-value

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

500Something went wrong on our end.

Something went wrong on our end.

typestring (uri)
https://inputbuffer.io/docs/api/problems/internal-error

A URI identifying the error type. Stable across releases, so it is safe to switch on.

titlestring

A short label for the error type.

detailstring

An explanation of this specific occurrence. May change between releases, so don't parse it.

statusinteger

The HTTP status code, mirroring the response status.

categorystring
"user"
"integration"

Who most likely caused the problem. user means the person using your app sent something the API rejected, such as a bad value or too many requests; detail is safe to show them. integration means the problem is in your own setup or code, so show them something generic and log detail for yourself. Omitted on internal-error.

fieldstring

Which request field caused the error. Present only on missing-required-field and invalid-field-value.

https://inputbuffer.io/api/v0/feedback//notes
{}