Target

Create a Target for a specific Workspace

post

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/v2/workspaces/{workspaceId}/target

This endpoint allows you to create a new Target within a specified Workspace. The request body should contain the necessary details for the new Target.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Request payload to create a new Target.

Responses

200

OK

application/json

idinteger · int32Required

scanIdinteger · int32Required

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/api/v2/workspaces/{workspaceId}/target

HTTPcURLJavaScriptPython

POST /api/v2/workspaces/{workspaceId}/target HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 974

{
  "connection": {
    "type": "AZURE_OPENAI",
    "config": {
      "apiKey": "api_key",
      "url": "https://your-azure-openai-endpoint.openai.azure.com/",
      "systemPrompt": null,
      "deploymentName": "gpt-4o-deployment",
      "apiVersion": null,
      "extraLlmParams": null
    }
  },
  "settings": {
    "name": "Example Target",
    "environment": "PROD",
    "description": "This is an example target for demonstration purposes.",
    "language": "en",
    "rateLimit": 100,
    "supportedModes": [
      "text",
      "video"
    ],
    "concurrentRequests": true,
    "multiStepAttacks": true,
    "systemPromptConfigurations": {
      "systemPromptConfidential": "This is a confidential part of the system prompt.",
      "systemPromptNotConfidential": "This is a non-confidential part of the system prompt.",
      "systemPromptTools": "These are the tools available for the system prompt."
    },
    "ragFileId": "319b2ff1-614e-4e61-96fc-403c5d3e48c7",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "This is a predefined response."
      }
    ],
    "ragFileNumberOfFacts": 5,
    "targetPresetId": "0e731c86-a3c7-4850-af0e-5b9b9fc4defe",
    "workerPoolId": null
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "id": 1,
  "scanId": 1,
  "connection": {
    "type": "text",
    "config": null
  },
  "settings": {
    "name": "text",
    "environment": "text",
    "supportedModes": [
      "text"
    ],
    "description": "text",
    "concurrentRequests": true,
    "multiStepAttacks": true,
    "language": "text",
    "rateLimit": 1,
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
    "predefinedResponses": [
      {
        "value": "text",
        "type": "text"
      }
    ],
    "ragFileNumberOfFacts": 1
  }
}

Update a Target for a specific Workspace

patch

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/v2/workspaces/{workspaceId}/target/{targetId}

This endpoint allows you to update an existing Target within a specified Workspace. The request body should contain the updated details for the Target.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Request payload to update an existing Target.

Responses

200

OK

application/json

idinteger · int32Required

scanIdinteger · int32Required

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

patch

/api/v2/workspaces/{workspaceId}/target/{targetId}

HTTPcURLJavaScriptPython

PATCH /api/v2/workspaces/{workspaceId}/target/{targetId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 974

{
  "connection": {
    "type": "AZURE_OPENAI",
    "config": {
      "apiKey": "api_key",
      "url": "https://your-azure-openai-endpoint.openai.azure.com/",
      "systemPrompt": null,
      "deploymentName": "gpt-4o-deployment",
      "apiVersion": null,
      "extraLlmParams": null
    }
  },
  "settings": {
    "name": "Example Target",
    "environment": "PROD",
    "description": "This is an example target for demonstration purposes.",
    "language": "en",
    "rateLimit": 100,
    "supportedModes": [
      "text",
      "video"
    ],
    "concurrentRequests": true,
    "multiStepAttacks": true,
    "systemPromptConfigurations": {
      "systemPromptConfidential": "This is a confidential part of the system prompt.",
      "systemPromptNotConfidential": "This is a non-confidential part of the system prompt.",
      "systemPromptTools": "These are the tools available for the system prompt."
    },
    "ragFileId": "c3ba6b13-fcf0-46ba-a89a-bbe6a5a5e37b",
    "predefinedResponses": [
      {
        "type": "text",
        "value": "This is a predefined response."
      }
    ],
    "ragFileNumberOfFacts": 5,
    "targetPresetId": "a6ae93bc-7243-4c07-814f-d36b5799cfa3",
    "workerPoolId": null
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "id": 1,
  "scanId": 1,
  "connection": {
    "type": "text",
    "config": null
  },
  "settings": {
    "name": "text",
    "environment": "text",
    "supportedModes": [
      "text"
    ],
    "description": "text",
    "concurrentRequests": true,
    "multiStepAttacks": true,
    "language": "text",
    "rateLimit": 1,
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
    "predefinedResponses": [
      {
        "value": "text",
        "type": "text"
      }
    ],
    "ragFileNumberOfFacts": 1
  }
}

Retrieve a Target for a specific Workspace

get

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/v2/workspaces/{workspaceId}/target/{targetId}

This endpoint allows you to retrieve details of a specific Target within a specified Workspace.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

OK

application/json

idinteger · int32Required

scanIdinteger · int32Required

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/v2/workspaces/{workspaceId}/target/{targetId}

HTTPcURLJavaScriptPython

GET /api/v2/workspaces/{workspaceId}/target/{targetId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "scanId": 1,
  "connection": {
    "type": "text",
    "config": null
  },
  "settings": {
    "name": "text",
    "environment": "text",
    "supportedModes": [
      "text"
    ],
    "description": "text",
    "concurrentRequests": true,
    "multiStepAttacks": true,
    "language": "text",
    "rateLimit": 1,
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
    "predefinedResponses": [
      {
        "value": "text",
        "type": "text"
      }
    ],
    "ragFileNumberOfFacts": 1
  }
}

Delete Target from Workspace.

delete

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/workspaces/{workspaceId}/target/{targetId}

Delete Target from the Workspace.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

targetIdinteger · int32Required

Target Id.

workspaceIdinteger · int32Required

Workspace Id.

Responses

200

OK

application/json

idinteger · int32Required

scanIdinteger · int32Required

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

delete

/api/workspaces/{workspaceId}/target/{targetId}

HTTPcURLJavaScriptPython

DELETE /api/workspaces/{workspaceId}/target/{targetId} HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "scanId": 1,
  "connection": {
    "type": "text",
    "config": null
  },
  "settings": {
    "name": "text",
    "environment": "text",
    "supportedModes": [
      "text"
    ],
    "description": "text",
    "concurrentRequests": true,
    "multiStepAttacks": true,
    "language": "text",
    "rateLimit": 1,
    "targetPresetId": "123e4567-e89b-12d3-a456-426614174000",
    "systemPromptConfigurations": {
      "systemPromptConfidential": "text",
      "systemPromptNotConfidential": "text",
      "systemPromptTools": "text"
    },
    "ragFile": {
      "ragFileId": "123e4567-e89b-12d3-a456-426614174000",
      "ragFileName": "text",
      "ragFileUrl": "text"
    },
    "workerPoolId": "123e4567-e89b-12d3-a456-426614174000",
    "predefinedResponses": [
      {
        "value": "text",
        "type": "text"
      }
    ],
    "ragFileNumberOfFacts": 1
  }
}

Get Target types.

get

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/target/types

Retrieves a list of available Target Types (e.g. Private With RAG), including metadata and associated probe settings.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Responses

200

OK

application/json

Defines various target configurations and their key characteristics. It helps determine which Probes are most appropriate and what Risk Levels apply, ensuring accurate analysis based on the specific setup.

idstring · uuidRequired

Target type Id.

labelstringRequired

Target type label/name.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/target/types

HTTPcURLJavaScriptPython

GET /api/target/types HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "details": [
      {
        "probeId": 1,
        "isRecommended": true,
        "weight": "LOW"
      }
    ]
  }
]

Retrieve overall scores and category breakdown for a Target

get

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/workspaces/{workspaceId}/target/{targetId}/scores

Returns the overall score and scores per category for a specific Target within a Workspace. Scores are calculated based on the latest probe run results and provide insights into security vulnerabilities, compliance issues, and other risk factors.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

OK

application/json

Response payload containing overall score overview and detailed category breakdown from probe scan results.

simulatedAttacksinteger · int32Required

Total number of simulated attacks executed during the probe runs.

successfulAttacksinteger · int32Required

Number of attacks that successfully exploited vulnerabilities or weaknesses.

overallScoreinteger · int32Required

Current overall score calculated from all probe results. Scale: 0-100 (0 = Critical Risk, 100 = Low Risk).

latestExecutionDatestring · date-timeRequired

Timestamp of the most recent probe execution used in this overall score calculation.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/workspaces/{workspaceId}/target/{targetId}/scores

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/target/{targetId}/scores HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

{
  "simulatedAttacks": 1,
  "successfulAttacks": 1,
  "overallScore": 1,
  "scores": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "latestExecutionDate": "2026-03-20T11:46:37.931Z"
}

Retrieve test runs for a Target

get

https://api.probe.splx.aihttps://us.api.probe.splx.ai

/api/workspaces/{workspaceId}/target/{targetId}/test-runs

Returns a list of test runs for a specific Target within a Workspace. This includes all test runs with their execution status, progress, probes and result summaries.

Authorizations

API Key

X-Api-KeystringRequired

API Key for authentication

Path parameters

workspaceIdinteger · int32Required

Workspace Id.

targetIdinteger · int32Required

Target Id.

Responses

200

OK

application/json

Response payload containing execution details and status information for a test run.

idinteger · int32Required

Unique identifier for the test run execution.

namestring · nullableRequired

Name of the test run execution.

executionDatestring · date-time · nullableOptional

Timestamp when the test run was executed. Null if not yet executed.

startedBystring · nullableRequired

Email of the user who initiated this test run.

errorCountinteger · int32Optional

Number of test cases that encountered execution errors.

passedCountinteger · int32Optional

Number of test cases that passed (no risk found).

failedCountinteger · int32Optional

Number of test cases that failed (potential risk detected).

totalCountinteger · int32Optional

Total number of test cases planned for execution.

progressnumber · floatOptional

Test run progress.

statusstring · nullableRequired

Current status of the test run (e.g., 'RUNNING', 'COMPLETED', 'FAILED' and 'CANCELLED').

probesstring[] · nullableRequired

List of probe names included in this test run.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/api/workspaces/{workspaceId}/target/{targetId}/test-runs

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/target/{targetId}/test-runs HTTP/1.1
Host: api.probe.splx.ai
X-Api-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "executionDate": "2026-03-20T11:46:37.931Z",
    "startedBy": "text",
    "errorCount": 1,
    "passedCount": 1,
    "failedCount": 1,
    "totalCount": 1,
    "progress": 1,
    "status": "text",
    "probes": [
      "text"
    ]
  }
]