Skip to content
Proud to collaborate with Microsoft for Startups

firecrawl.search.submit-search-feedback ​

Submit feedback for a search job

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-firecrawl
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization that owns the connection. Resolved from the authenticated context; callers never pass it
cloud_connection_uuiduuidNo—Firecrawl connection to use (API key and optional self-hosted base_url). Omit to use the organization's only active Firecrawl connection
jobidstringYes—Search job id returned by /search.
ratingstringYes——
valuablesourceslistNo——
missingcontentlistNo——
querysuggestionsstringNo——
originstringNo——
integrationstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization that owns the connection. Resolved from the authenticated context; callers never pass it
cloud_connection_uuiduuidNo—Firecrawl connection to use (API key and optional self-hosted base_url). Omit to use the organization's only active Firecrawl connection
jobidstringYes—Search job id returned by /search.
ratingstringYes——
valuablesourceslistNo——
missingcontentlistNo——
querysuggestionsstringNo——
originstringNo——
integrationstringNo——
status_codeintegerNo—HTTP status code of the completed call
responsejsonNo—Parsed JSON response body
failure_reasonstringNo——
failure_typestringNo——
failed_atstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—executeWaiting to call POST /search/{jobId}/feedback
completedNoYesYes—HTTP call succeeded
failedNoYesNo—HTTP call failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompletedPerform POST /search/{jobId}/feedback
* (any state)failfailedRecord the failure reason

Outcomes ​

OutcomeTypeDescriptionState Data Keys
completedSUCCESSThe provider accepted the requeststatus_code, response
failedFAILUREThe provider rejected the request or was unreachablefailure_reason, failure_type, status_code

Business Errors ​

CodeMessage Template
HTTP_AUTHENTICATION_FAILEDThe provider rejected the credential (HTTP {status_code})
HTTP_AUTHORIZATION_FAILEDThe credential is not permitted to perform this operation (HTTP {status_code})
HTTP_NOT_FOUNDThe provider has no resource at {path} (HTTP 404)
HTTP_RATE_LIMITEDThe provider rate-limited this request (HTTP 429)
HTTP_REQUEST_FAILEDThe provider returned HTTP {status_code} for {method}
HTTP_RESPONSE_SHAPE_UNEXPECTEDThe provider response for {method} {path} could not be parsed as JSON
FIRECRAWL_CONNECTION_MISSINGfirecrawl_connection_missing: this organization has no active {connection_type} connection. Create one with connection.setup (type {connection_type}).
FIRECRAWL_CONNECTION_AMBIGUOUSfirecrawl_connection_ambiguous: this organization has more than one active {connection_type} connection. Pass cloud_connection_uuid to choose one.
FIRECRAWL_CONNECTION_NOT_FOUNDfirecrawl_connection_not_found: no {connection_type} connection {connection_uuid} in this organization.
FIRECRAWL_CONNECTION_CREDENTIAL_MISSINGfirecrawl_connection_credential_missing: the {connection_type} connection has no api_token. Update the connection with a Firecrawl API key.

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "firecrawl.search.submit-search-feedback",
  "initial_data": {
    "jobid": "value",
    "rating": "value"
  }
}