Components

Create a response for a question about a component

Generate a response to a question about a visual component using its content and description.

post/api/v0/components/{component_id}/responses

Request

Base URL
https://api.outerport.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/components/:component_id/responses/post.ts
A function with typed inputs. Its response is checked against the schema.

component_idstring required

questionstring required

The question to ask about the component

Successful Response

answerstring required

The answer to the question

answer_cut_offboolean required

True when the answer reached the output limit, so answer holds only the text received.

Nov 9, 2026ecd5b922e78a Revision changes
- info
  added the required property to the response with the status