Skip to content

feat: Document /acts/ACTOR-ID/validate-input endpoint #2384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gemini-25-pro-collab wants to merge 1 commit into from
+44 −0
Closed

feat: Document /acts/ACTOR-ID/validate-input endpoint #2384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apify-api/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,8 @@ paths:
$ref: "paths/actors/acts@{actorId}@run-sync.yaml"
"/v2/acts/{actorId}/run-sync-get-dataset-items":
$ref: "paths/actors/acts@{actorId}@run-sync-get-dataset-items.yaml"
"/v2/acts/{actorId}/validate-input":
$ref: "paths/actors/acts@{actorId}@validate-input.yaml"
"/v2/acts/{actorId}/runs/{runId}/resurrect":
$ref: "paths/actors/acts@{actorId}@runs@{runId}@resurrect.yaml"
"/v2/acts/{actorId}/runs/last":
Expand Down
42 changes: 42 additions & 0 deletions apify-api/openapi/paths/actors/acts@{actorId}@validate-input.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
post:
tags:
- Actors
summary: Validate Actor input
description: |
Validates whether the provided JSON payload matches the Actor input schema without starting a run.
Use this endpoint before triggering an Actor to catch schema violations and return actionable error messages.
operationId: act_validate_input_post
parameters:
- $ref: "../../components/parameters/runAndBuildParameters.yaml#/actorId"
requestBody:
description: JSON payload to validate against the Actor input schema.
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
responses:
"204":
$ref: ../../components/responses/NoContent.yaml
"400":
$ref: ../../components/responses/BadRequest.yaml
"401":
$ref: ../../components/responses/Unauthorized.yaml
"403":
$ref: ../../components/responses/Forbidden.yaml
"404":
description: Not found - the requested resource was not found.
content:
application/json:
schema:
$ref: "../../components/schemas/common/errors/ActorErrors.yaml#/ActorNotFoundError"
"405":
$ref: ../../components/responses/MethodNotAllowed.yaml
"413":
$ref: ../../components/responses/PayloadTooLarge.yaml
"415":
$ref: ../../components/responses/UnsupportedMediaType.yaml
"429":
$ref: ../../components/responses/TooManyRequests.yaml
deprecated: false