XPxpander
API v1
Custom Functions
Custom Functions CRUD

Get Custom Function

Get a custom function by ID, including its source code, input schema, and status.

get/v1/custom_functions/{function_id}

Request

  • Base URL
    https://api.xpander.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-api-key

Path parameters

function_idstring required

Response

Successful Response

idstring required

Unique identifier of the custom function.

namestring required

Human-readable name of the function.

descriptionstring nullable

Description of what the function does.

technical_descriptionstring nullable

Auto-generated technical description from code analysis. Explains the function's logic, inputs, and outputs.

statusstring nullable

Current function status. 'analysing' = being analyzed after create/update, 'ready' = available for execution, 'error' = analysis failed (check analysis_error_details), 'draft' = not yet analyzed.

input_schemaobject nullable

Auto-detected JSON schema of the function's input parameters. Generated during analysis from the function signature and type hints.

source_codestring nullable

Python source code of the function. Only included in get-by-id responses, not in list.

analysis_error_detailsstring nullable

Error details if the function analysis failed. Only present when status is 'error'.

organization_idstring nullable

Organization that owns this function.

project_idstring nullable

The project the item belongs to; unset means the org's Default project on create.

created_atstring nullable

ISO timestamp of when the function was created.

Changes

No recorded changes to this operation across all 4 revisions of this API.