Skip to main content

Function API Endpoints

1. Create Function Endpoint​

  • Method: POST

  • Parameters:

    • name: Name of the function.
    • type: Type of function (e.g., quantum, GPU).
    • template: Code template (e.g., Qiskit, CUDA).
    • description: Optional description of the function.
    • provider: Cloud provider/service (AWS, IBM, etc.).

  • Response:

    • Success: Returns 201 Created status and details of the created function.

2. Edit Function Endpoint​

  • Method: PUT

  • Parameters:

    • function_id: ID of the function to edit.
    • new_code: Updated source code or template.
    • new_name: New name (optional).
    • description: Updated description (optional).

  • Response:

    • Success: Returns 200 OK status and updated function details.

3. View Function Details Endpoint​

  • Method: GET

  • Parameters:

    • function_id: ID of the function to view.

  • Response:

    • Success: Returns 200 OK status and function details, including code, status, deployment information, and logs.

4. Delete Function Endpoint​

  • Method: DELETE

  • Parameters:

    • function_id: ID of the function to delete.

  • Response:

    • Success: Returns 204 No Content status to confirm deletion.