API and agentsAPI reference
AssistantEvent
object
One streamed event. text_delta carries an incremental text chunk and messageId; message carries the complete text for that same messageId. Legacy clients ignore deltas; delta-aware clients replace that message at completion, never append it twice. Recovery text is a replacement snapshot, not a delta. Partial tool arguments and private reasoning are not emitted or executed. Action events carry resolved effects; confirm_required carries target and consequence words. outcome distinguishes succeeded, accepted, refused and uncertain; jobId identifies accepted asynchronous work. type is one of text_delta, message, tool_call, tool_result, observation, confirm_required, error, done. On confirm_required, id is the server-issued pending-action id a resolution references (not a provider tool-call id); the run has paused and the stream ends until a resolution request continues it.
typestringrequiredOne of
text_delta,message,tool_call,tool_result,observation,confirm_required,error,donetextstringmessageIdstringmodelstringActual provider model on a completed model message.
effectsAssistantEffectsconfirmationAssistantConfirmationcallIdstringOn confirm_required: the provider tool-call id the gate holds.
outcomestringOne of
succeeded,accepted,refused,uncertainjobIdstringlabelstringOn tool_call and tool_result: the record's line for the action.
subjectAssistantSubjectelapsedMsintegerminimum0On tool_result: execution time around the dispatch alone.
historyAssistantHistorydecisionstringOn the tool_result a resolution settled: how.
One of
approved,declinedrenderMapLookRenderOn a map check's tool_result: the render's facts, never its bytes.
automaticbooleanOn a map check's tool_call and tool_result: the loop scheduled it itself.
One of
truestatestringOn observation: the observation's lifecycle state; id names the check action, text the displayed sentence, reason why none will come.
One of
awaited,captured,silent,interrupted,unavailableidstringtoolstringargsobjectokbooleanbodycodestring144 values
picture_upload_retired,setting_locked,project_owner_cannot_leave,method_not_allowed,authentication_required,invalid_credentials,account_deactivated,setup_complete,weak_password,email_taken,self_change_refused,account_not_deactivated,deletion_in_progress,deletion_unreadable,deletion_changed,last_admin,forbidden,invalid_link,token_expired,rule_refused,current_password_required,authentication_busy,ingress_unavailable,geometry_not_supported,geometry_choice_invalid,geometry_in_flight,unsupported_format,unsupported_image,image_too_large,upload_too_large,archive_too_large,remote_fetch_failed,remote_fetch_abandoned,remote_too_large,remote_timeout,egress_blocked,imagery_unavailable,area_too_large,name_taken,not_refreshable,dependencies_unresolved,export_failed,refresh_in_flight,connection_failed,connection_password_required,malformed_file,request_body_too_large,mcp_read_failed,mcp_transport_failed,mcp_response_invalid,stale_revision,invalid_request,not_found,sql_rejected,sql_error,query_timeout,engine_memory_exceeded,data_processing_timeout,request_timeout,upload_stalled,render_bytes_exceeded,query_memory_exceeded,query_result_too_large,tile_build_timeout,render_cap_exceeded,tiler_unavailable,tile_build_failed,render_unavailable,render_timeout,render_failed,look_target_missing,look_image_too_large,look_image_unavailable,attachment_too_large,operation_timeout,operation_queue_full,run_in_flight,plan_changed,operation_interrupted,input_changed,geocoder_unconfigured,geocoder_failed,isochrone_unconfigured,isochrone_failed,service_address_unreadable,basemap_not_offered,measurement_crs_unavailable,operation_superseded,widget_layer_missing,column_unavailable,field_not_published,catalogue_not_published,selection_incompatible,rate_limited,catalogue_too_large,assistant_reservation_required,assistant_run_unavailable,assistant_run_conflict,assistant_capacity,assistant_run_state,assistant_submission_too_large,assistant_recovery_limit,assistant_plan_unavailable,assistant_action_uncertain,assistant_action_interrupted,assistant_action_not_admitted,assistant_choice_invalid,assistant_model_not_offered,assistant_effort_not_offered,assistant_effort_not_supported,assistant_context_invalid,assistant_context_too_large,assistant_context_unavailable,assistant_disabled,assistant_auth,assistant_provider,pending_unknown,pending_resolved,pending_superseded,invalid_sketch_feature,not_a_sketch,feature_not_found,vertex_move_refused,sketch_gone,map_not_found,template_not_listed,templates_catalogue_off,template_archive_too_large,template_checksum_mismatch,template_unpacked_too_large,template_malformed,template_entry_escapes,template_members_mismatch,template_format_unsupported,template_invalid,template_forbidden,template_picture_too_large,template_licence_refused,template_credit_missing,template_reference_outside,template_record_mismatch,template_not_installed,template_reference_unbound,internalmessagestringreasonstringOn done: why the turn ended (end, budget, interrupted). On observation: why no observation will come (cancelled, exhausted, failed); the loop yields exhausted when the last step was spent on the check itself.
One of
end,budget,interrupted,cancelled,exhausted,failed
7439201b