# Publish service
Complete the actions to create a Spark service after [Upload Excel file to Spark](/spark-apis/service-apis/upload-spark-service.md). Compilation must be complete before publishing, [Check compilation status](/spark-apis/service-apis/check-compilation-status.md).
Returns: `status` of publish job.
{% code overflow="wrap" %}
```shellscript
POST /{tenant}/api/v3/folders/{folder}/services/{service}/publish
```
{% endcode %}
### Authorization
* `Bearer {token}` accessible from [Authorization - Bearer token](/spark-apis/authorization-bearer-token.md) or systematically via [Client Credentials](/identity-and-access-management/client-credentials.md).
* The request headers should include a key for `Authorization` with the value `Bearer {token}`.
* API key created from [Authorization - API keys](/spark-apis/authorization-api-keys.md).\
The [Authorization - API keys](/spark-apis/authorization-api-keys.md#api-key-groups) must contain [Manage users](/tenant-administration/manage-users.md#user-groups) that are also assigned to [Permissions - Features permissions](/spark-apis/authorization-api-keys/permissions-features-permissions.md) `Spark.ServicePublish.json` or `Spark.AllEncompassingProxy.json`.
* The request headers should include the keys `x-synthetic-key` and `x-tenant-name` with the API key and tenant name respectively.
### Path parameters
| Key | Value |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tenant` \* | Tenant is part of your [Login and logout](/navigation/login-and-logout.md#log-in-to-spark) URL and also available in the [Navigation menu](/navigation/navigation-menu.md#user-menu). |
| `folder` \* | Target folder name. This should be the same as in [Upload Excel file to Spark](/spark-apis/service-apis/upload-spark-service.md). |
| `service` \* | Target folder name. This should be the same as in [Upload Excel file to Spark](/spark-apis/service-apis/upload-spark-service.md). |
### Request body
`Content-Type: application/json`
| Key | Value |
| ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `request_data.original_file_documentid` \* | `id` from [Upload Excel file to Spark](/spark-apis/service-apis/upload-spark-service.md). |
| `request_data.engine_file_documentid` \* | `id` from [Upload Excel file to Spark](/spark-apis/service-apis/upload-spark-service.md). |
| `request_data.draft_service_name` \* | Target service name overrides `service` from [Upload Excel file to Spark](/spark-apis/service-apis/upload-spark-service.md). |
| `request_data.version_label` | Version label for service version. This will appear in the user interface dropdowns. |
| `request_data.releasenote` | Release note for service version. |
| `request_data.effective_start_date` | Timestamp to set the parameters for the
/pages/-Mbp9Z03Ck-4xgQWd-9o capability.
Use Timestamp Converter to convert dates to ISO 8601. The value in /pages/X9Uq7qE0uvW0E8aNtCCM is ignored.
Example: 2026-01-19T16:05:23.517Z
|
| `request_data.effective_end_date` | Timestamp to set the parameters for the
/pages/-Mbp9Z03Ck-4xgQWd-9o capability.
By default, the Spark UI will use the current date and time for this value. Use the Timestamp Converter to convert dates to ISO 8601. The value in /pages/X9Uq7qE0uvW0E8aNtCCM is ignored.
Example: 2126-01-19T16:05:23.517Z
|
| `request_data.version_difference` | major, minor, patch, or custom
method of updating Semantic Versioning.
This can be a different value than what was initially provided in /pages/X9Uq7qE0uvW0E8aNtCCM.
|
| `request_data.should_trck_user_action` | "true"
String boolean to set whether or not an Event would be recorded for this action. Events are visible in the /pages/-MbpDetRGEED\_VkN4hsY#event-viewer.
|
| `request_data.tags` | Comma separated string of tags.
Example: abc,def
|
| `request_data.description` | Description for service version. |
| `request_data.semantic_version` | Semantic version needs to be populated if
version\_difference is custom.
|
#### Sample request
```json
{
"request_data": {
"draft_service_name": "my service name",
"version_label": "my service label",
"effective_start_date": "2024-01-19T12:12:00.000Z",
"effective_end_date": "2126-01-19T12:12:00.000Z",
"original_file_documentid": "4c4cef82-3f30-45ae-ade8-b43f4ab29779",
"engine_file_documentid": "d84bf685-2ed6-4d95-8fb1-d01770a0e0d8",
"version_difference": "minor",
"releasenote": "my release note",
"description": "my description",
"should_trck_user_action": "true"
}
}
```
### Sample response
`HTTP 200 OK` `Content-Type: application/json`
If the service name already exists, Spark will raise an error message.
```json
{
"status": "Success",
"response_data": {
"version_id": "7004e077-153f-4561-97ee-eb8124f6eb72"
},
"response_meta": {
"system": "SPARK",
"request_timestamp": "2023-05-18T21:20:42.498Z"
},
"error": null
}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.coherent.global/spark-apis/service-apis/publish-service.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.