# Metadata API

Get data from the [How to: Work with subservices](/build-spark-services/subservices.md#metadata-subservice) without recalculating the entire Spark service.

Returns: Metadata subservice data from Spark service.

{% code overflow="wrap" %}

```shellscript
GET /{tenant}/api/v3/folders/{folder}/services/{service}/metadata
GET /{tenant}/api/v3/service/{serviceId}/metadata
GET /{tenant}/api/v3/version/{versionId}/metadata
GET /{tenant}/api/v3/public/version/{versionId}/metadata
GET /{tenant}/api/v3/public/service/{serviceId}/metadata
GET /{tenant}/api/v3/public/folders/{folder}/services/{service}/metadata
```

{% 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 request headers should include the keys `x-synthetic-key` and `x-tenant-name` with the values of the API key and tenant name respectively.
* No Authorization is required for [Authorization - Public APIs](/spark-apis/authorization-public-apis.md).

### Path parameters <a href="#uri" id="uri"></a>

<table><thead><tr><th width="374">Key</th><th>Value</th></tr></thead><tbody><tr><td><code>tenant</code> *</td><td>Tenant is part of your <a data-mention href="/pages/-MboyUpg0GSvjBVkVMcw#log-in-to-spark">/pages/-MboyUpg0GSvjBVkVMcw#log-in-to-spark</a> URL and also available in the  <a data-mention href="/pages/ylWjjoVBLOcB7JZks4Cp#user-menu">/pages/ylWjjoVBLOcB7JZks4Cp#user-menu</a>.</td></tr><tr><td><code>folder</code> *</td><td>Folder associated with the request.</td></tr><tr><td><code>service</code> *</td><td>Service associated with the request.</td></tr><tr><td><code>serviceId</code> *</td><td><code>service_id</code> of the requested service. The latest service version will be referenced.</td></tr><tr><td><code>versionId</code> *</td><td><code>version_id</code> of the requested service version.</td></tr></tbody></table>

### Sample response <a href="#api-response" id="api-response"></a>

`HTTP 200 OK` `Content-Type: application/json`

Follows from [Execute API (v3)](/spark-apis/execute-api/execute-api-v3.md) [Execute API (v3)](/spark-apis/execute-api/execute-api-v3.md#response-body).

```json
{
    "status": "Success",
    "response_data": {
        "outputs": {
            "Metadata.Date": "2002-01-01",
            "Metadata.Number": 456,
            "Metadata.Text": "DEF",
            "METADATA.IMAGE": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOQAAABLCAYAAABgHSu2AAAABHNCSVQICAgIfAhkiAAAFgZJREFUeJztnWlzHMeZ539ZVzf6QgPduG8QNylKmtFhUpdt0RpLsmdlr3bGjo21X2zsvpiYN/4A8xUc6whHOGIjHBvzygfX0tCjkYYcibJIiiYZpkES4AWCIACCBBp9AI0G+qyqnBeFbpG0CN5EQ6xfRAFoRGV2Vlb+83nyyawssbKyInFxcdlsXgqFQkeVzS6Fi4vLF7iCdHGpIlxBurhUEa4gXVyqCFeQLi5VhCtIF5cqwhWki0sV4QrSxaWKcAXp4lJFuIJ0cakiXEG6uFQRriBdXKoIV5AuLlWEK0gXlyrCFaSLSxWhbXYBbosAIUAoX/xdQYJcP7DXf7t8ZRHK+v1XQMD6DwcpcdqD7RxbnaoTZFmEZgHSswprCwq5JYXiKtimQCgSvQa8YYmv0SbUYeMNy8pNcfnqIFRAwlpckJlTycYF+RWBlRdICaohMYISX0QSaLEJtdkoGti2k24rUj2CFE7Hl08LYqc1FsdVMtcVcnFBPi0oZQW25QhW84InJKmpt/E3SyIDFs3PmIQ6bITiCnOrIxSwTUhOqMROaaQuK6zOK+SSgsKKwCwAElQDjIDEWyfxN9mEu2wad1o07jDRfVuzHYhq2MJDKGDmYeGUxuwhndQlhcx1xbGWAkept7is4FS4bTvWsm6bRevzJu27TAJNEtvchAtxeWAUFZZnFGYP6yyMqqQuqeheiPRDuAv8DWD4nTZTykEuBek5SF2GlesQ7rGJjph0f90kOmw5Q55Nb+F3xUuhUOjopltIoUJ+SXDloM6Vj3VWrjpxJmWjkokv0qoqFFcFC6May1dU0rMqfd8uEhmwXVFuMYQC86Mqkx8aXP+TRk0YBr4NrX8FdV1QUw+e4A1tQ0JhDfIpWJmH2BjMHlOYOmCQnlbZ9u0SnS+X0DxbJ86wqYIUKmQXBZP/bjD1Hzr5lHDGDfeaj3DyKqQFs5/pFFYEQ98r0jhiYVsPv9wujwAB145rnH/PIH5Wpe05GHobmneCr/72aTwB56jthKYd0P4CTOyHSwdUCr8RmHno/oaJ4ZdbwoXdNEEKBXJJwdQnOpMf6RQz9yfGW/M0C7BwUgMbNG+Bum57y/SOTyrShvh5lbO/NUhNqPTvgZHvQ3TAcWHvFsPvCNjfCP4IjP1/hfO/86B5oWOXie6TVd8WNm0e0rZg/qTG5Y8MR4wPqSRCgFWC2GmNiX0GpdzDydflESGdQN653xgsT6n0fhN2/hAahu5NjDcSbIbt34ft/xWsnODcXoOlKWVLWMhNEaRQYXlKZe6YRjb58MRYyV84QaL4WY1rx/WHm7nLQ8UqwewhnaXLKtEB2Pl3UNdzy7zzfeANw47vQ8fXIJ9SmDmkk00oD72tPWw2p3g2xM6oxEY1lLssgZQgLSccblvcMXImFMjGBVc+0bEKD3h3XR4NEooZweV/17GKguHvOpHUBxVjmZo6GP5b8EVg5g8ayzNK1busj30MKRRYuaqQmlQx86DchQHTvNCyE1qfhfo+WJ6Gs+874e6NejzbgtUFQfycQvMz1s1TJy6bjlWC2JhGPi1oGISWZ0DzbHC+ZXFu/BIf/OunnDs7SXNLA9/57jd4+dXnUNUv928bh6Dlabj8iSB+VqVum4UvUr0BnsduIYUCK3MKmWsKQr2zRoQC9b2w413H/WgchtoO7iqULQSYOUHinFb1PeMThwC7JIiPqwgE7c87UxobsbycIZlYZufOIf7hH/87Pb0d7Hv/Y86dnbxtGkV3pk1q6iB1SSWfUh6aBX4UPH4LKSAbV8gmBELcec5W2pCagiM/dSp259/jLJO7qy8DsyBYnq3ygcMTim3C8rRzb6KDzsqbjaitDfD8iztRVRXDo2N4DGLzi6SS6Q3TRfrACDqGoJARVe0pPf5pDwGFjDOZf7c9lZmHzALklrjneUW7BLlEFd+BJxjbcjpngFDrnaOqmqahBZwma5kWuWyeXK6A17uxkoPNoHshnxKYOVxB3opdEtilO/eIN3GflShtx0ra5v2H0V0eAQKkJbAKzrBEq+Gu77Ft24yNXeTjA5/T09vB9qcGNjxfNZzIvlVy2p60nABhNSHWx7SbIkihyscmDqHA2oLCv/3vQFX3jE8i0gazKNC9YBXvLk2xWOKPR0fZ/+FnbOvr4nvv/g2BgG/DNLbpfJeqw8n/6+HU/9sgcrRJyHV38fELUoIRAD0gMbOP3p8XijOwN/OP9ntc7h3JehxBwmoM/NGN1zCbpsWnn/yRI4f+xCuvPc/Xv/k1vN47i2stDlYBFMOxyqZZfRE+e10Hj12QUoIvKvHVS9JrAuUuAjv3/2WgeSU93zQZ+UGhqqNrTxpCOHGE0//sYeHPGslL60vlNmiR16/FuHB+irr6WoaGt5FMplFVhWDARyDov2261BQUVqGu12Ln/ygQGbCwrSprDEJC02YI0oZgq0Wg1XYmau8hAGqbUFyFYtbJ505VKiXoPklkxMTwSddlrTKEAg3bTRb+rHLtpKD3G6DX3P78dDrDxMUr/PHon9n7mw+RtqS5pYH/+b/+G999Z8+XppE2zJ+C/DI0PmMRaLbRakDa1WclYZMEWdttE+6xuXb8XhLCtZNwfdT5aFvccTG6EM6zks1Pu4sCqhHFkDQ/a3HutzB/GuIXoP352wf7djw1wP/5+T8h7Rtm9YVAu82iAIClaafdlLLQuN3CF63eRQGwSUvnVA2adpo0PmXdU7RL2utL50zu6OdKCTURSdfXnVX+LtWHEOCtk/S8XkJR4cK/wuriRucLdF3D8BhfHIaOon55MzbzcOEDWEtA+0sm4R77gZ8oetRsiiBtGyKDFm0vmmg+Hv4gUjpjkXCvRderpYecucvDRDUkPXuK+Jpsro3C+d87AZ4HpZSDix/Blc9AKJLubxQJNNlVbR1hsxaXr++H0vaiSc+eorOe9WGJUgIKRAYsht4pYoRc61jNCAH+Bsn2vy/gb7A5+x6c+xdYuXb/T/kXVuDyJzD6z2AWJUPfLxIdtDfehaJK2LQiShsCLTb9b5Yw84KrRzSs/ANOg0hnXFk/YDH4vaLjEld5j+ji3LO2F0yKGcHFfQZnfquQTcLwf3HWMete7qpdWEVniuPSARjb61jfvrdK9LxewhOq/oeTYZO38JAWhDpttv9dEb1GMntIp5Aub5hzj3lJZ8F5ww6Twb8t0vJX7vYdWwmhQO8bJVQPXPpA5/KnKslJ2PZNaPtrZxcAvca5x+VxoJSOCM0c5JZh8Txc/hgWxqAmYtP7Ron+t0rO9h1bQIxQRbvOFTKC2SMaVz7WWYspjjDLBvPLxHnDznOaD3wRm+a/Ntn2Rolwl+2KcYsiFGc7j8kPdRLnVdYWFfxRaH4Kov0QbAVvCFCcyOlqzJlnjI07O8/V1EuCHTb9bxVpfd58uMOhR8tLoVDoaFUIEnBEJ2FtUXD1iM71PznPyZVWBaWcwC6u77MpnJU3mlei+ySeoCQyaNP5Son6AQtV35r7cbp8QXlb0NhpjdkjOulp5ymN0iqYeYG1vpugooLqAcMnMUISf4NN29cs2neV8NTe7SNBVUOVCXKd8j6spawgcUEhPaOyuqBQSINVdDbCMgISf4Mk1GERGbTwNziT/q4Qv1oI1RnWrMwppC6pZOYUskln02xpO52yt04SbJGEey3q+yxUz3o7qKpWfVdUpyAr3Ppuj/X/wQ3vc3Df7fFE8BfveCkPYcpGcL0NbPEOuTo2Sr4t8itRyS4PgfJ+Sk8C7qP0Li5VhCtIF5cqwhWki0sV4QrSxaWKcAXp4lJFuIJ0cakiXEG6uFQRj2UeUlVVVFVFURTk+iy+bdtYloVtuxONWxVFURBCYNt25b7eC0IIFEW57/S3lkW54UUxUsr7yrdcpnL6ey0D8EBt+pELUgjB6OgoBw8eJBaLIaXE6/UyMjLCrl276OjoeNRFcHlEzM3NkUql6OzsJBgMIu6wi5gQAiEEUkosyyKRSDA9PU1vby/19fU3CepeME2Tubk5JiYmsCwLIQThcJju7m4aGxvvOl8pJUtLS8zOzlJfX097e/sdr6l8Xblcjrm5OTRNo7Oz876v5ZG7rEII5ubmOHDgAJOTkwQCAdLpNL/+9a/51a9+xfz8/H0X3mXzKJVKzMzMMDY2RiKRuKNVKDf2c+fOkUwmKxaoWCw+kEURQmBZFsvLyywvL9PW1kZ3dzeGYTA2NkY8Hr+n/G3bplAoYJrmPZWjVCoRj8cr13a/PBaXtexODA0N8YMf/IClpSV+8YtfMDo6ymuvvUZXVxfwhakv96CKoqCq6k29qpQSTdMqn4UQlTcfmaZZ+XxjHmXXqvw/27Yrrkk5bdmFflDX6UlASsnq6iqpVKoitJaWFnw+H1LKSt2Wzy0fa2trXL16Fb/fTyQSIRqNEgqF8Hg8lXtarv8bremtn79MYKqqEg6H6e/vx+fzkclkOHHiBLFYjNraWnw+XyWfG/Mot41yWcPhMDt27EDTtMp3lg/gJje4fJ03/r4bi7oRj3Utq2EY1NbWUiqVUBSFmpoahBD8/ve/55NPPmF4eBghBN3d3ezevZvx8XGOHDnCxMQEvb297Nmzh7q6Ot577z38fj/f+c53WFlZ4f333ycQCPDOO++QzWbZv38/wWCQN954g+npaQ4dOsTVq1cZHh5mz5499PX1kc1m+cMf/sCxY8colUq8+OKLvPrqqzQ2Nj7OKtmSSClJJBJ4PB66urpYWVlhdXWVmpoapJTMz89z6dIl0uk0DQ0NbNu2DSEEFy9eZGFhASkluVyO+vp6pqen6ezsZG5ujsbGRpqbm9E0jcuXL1MsFmltbSWdTnP16lUKhQKNjY309PTg9/v/ovMsC822bTweDzU1NRSLRSzLYmZmhrm5OfL5PE1NTXR1daFpGlNTUywuLlaEtG3bNpaXl4lGozQ0NJBKpbh48SLxeJxwOMzg4CCNjY0Vz29ycpJCoUAoFCKbzRKNRh+obh+bIFVV5dNPP+X8+fMA1NXV8fbbb9PV1cWpU6fYv38/Z8+e5bnnnqO1tZUTJ07wy1/+krq6OgYHB5mYmODnP/857777LsvLy1y4cIGRkREWFxc5fPgw4XCYkZERVldXGR0d5YUXXmBqaoq9e/cSCAR4/fXXSSQSXLp0iUgkwv79+zl+/Dg7d+5ESslHH33E/Pw87777Lm1tbW6waQPK7lldXR3RaJSzZ8+STqepr69nYWGB6elpamtr6erqIh6PMzk5SU9PDy0tLWQyGVpaWmhqaiKbzRKPx2lra0MIwczMDLW1taiqyuzsLJFIhPn5edLpNNFoFL/fz8LCAhMTEwwPD+Px3Lxredk7EkKwtLREIpFgcHCQWCzGwsICDQ0N+P1+5ubmmJmZoampiVgsxtzcHDt27KC1tRXbtkkmk9TU1GAYBuPj49TV1dHW1kYmk+HMmTNs376dYrHItWvXiEaj1NXVEY/HSaVSW8dC2rZNV1cXu3fvJp1Oc/r0aUZHRysD4FAoxMsvv8wPf/hDFEVh7969ZLNZfvzjH7Nz505OnjzJT3/6U8bGxuju7ubKlSucOnWKRCKBpjmXMTY2RiaToVAo8OyzzxIIBCgUCpVOYGBggP7+fpaXl/n8889pbGzktddew+fzce3aNc6fP8/09DTNzc0PXLFfVcruajKZZGRkhPr6ejweD8vLy2SzWWKxGLqu093dTTgcJhqNks/n8fv9mKaJx+MhFAoRDAbJ5/MIIdA0jfb2dkZHR1ldXaVQKKAoCrW1tcRiMQzDoKOjA7/fTz6fZ3FxkdXVVbxeb6VcpmkyMzPDe++9h6qqBAIB2traaGpqYmJiglAoRHt7O8FgkGw2y9LSEplMBl3XiUQi9PT0EA6HSSQSCCEwTbMyNu7p6alYwKWlJebn51lZWaG+vp7e3l5CoRB+v5+1tbUHHvI8NkFKKeno6OBb3/oWqqqSSCQYHR1laGgIy7Lw+/0MDw/T09NDLBZjbW0NXddpaGggHA7T0NCAEIJsNkt/fz8nT57ks88+Q9M0nn76aVZXV9m3bx8ej4ddu3ZVKvgnP/kJo6OjnDp1ig8++ICpqSleeuklpqamuHDhAmfOnEFVVZLJJNFolLW1NWzbroxpXG6mbEGASkOMRCIsLS2xurqKaZpomoauO6/G9vv9+P3+DacghBAEAgGCwSBzc3NkMhkikQg+n498Ps/169dJJpMoikKhUMDn8/2FB6OqKk1NTTzzzDN4vV50Xa+MadfW1lhYWGBhYQFN0yodhG3bqKpasYY3Uo43lK9FSomu6xiGgWmaFItFdF2vGANd1yvnPQiPTZBCCDKZDLOzs6RSKWZmZtA0DcMwKoPh8kA6EAgwPDzMsWPH2LdvH8lkksOHD6NpGjt27GBgYIDh4WHOnz9Pc3Mzu3fvJpVKMT4+jqqqbN++nUAgwJkzZzh48CAtLS289dZb/O53v+P69et4vV4GBgZYWlrilVdewe/3c+rUKfx+P01NTa4YN6BUKlUa94cffoiqqhQKBXRdp62tDb/fTzKZJJFIYBgGMzMzJJNJent7K/PRXxbBLKc/duwYQgj6+voIhULU1NQQjUYr48Z4PE6xWLzJOoLTvrxeL9FoFJ/Pd1MQLxgMYhgG3d3d+P1+YrEYtm1TU3P79xZomobP52NmZoZEIkFLSwuJRIJ4PM7AwACGYZBMJolEIui6zuLiYiW49SA81jHksWPHGB8fxzAMOjs7efPNN3n22WeZn5+/KdLl8/l4/fXXKZVKfP755/zsZz+jqamJH/3oR7z66qtEo1GeeuopDh48SGNjI319faTTaVpbWwEYHBzE7/fT3t5OU1MThw8fZu/evXR1dfH222/z9NNPEwqFOHDgAIcOHcI0TYaGhnjzzTfp6+t7XFWy5Si7q8vLy+zevZvm5mZUVaVUKnH69GlWVlbo7u5G0zTOnDnD0aNHqauro7+/n3A4TKFQoLa2lpMnT3L9+nU6OzsreQshiEajRCIRvF4v4XAYj8fDwMAAk5OTnDhxgnw+TzQaZWhoqBLUuXVocWOkFpx2V45BHD9+vJLHyMjIbfMAJ/oaiUTo7+9nfHycQ4cOEQqF6O3tpbOzEyklly9f5vjx45imSSgUeiid+GPZwiOXy1XcGXAq3+Px4PP50HWdbDZLNpslGAxWei0pJfl8nlwuR6lUqrggHo8HIQTFYpGVlRVUVSUYDCKlZGVlBXBcKV3XsW2bfD5PNpvFNE0Mw6jkYVkWuVyOXC6HlBKPx4Pf76+4Wi5fjmVZFAoFDMOouGsAhUKh4uWU5xfLLp9hGJWpqFKpVImy67pOqVTC4/FUVscUi8X1VwboFStXTlMeSpTzKyOlxDRNLMuqtI8buV0eiqJQLBYr97+86qhUKqGqKpqmVa7XsiznVeo3XHepVKqkL5enfM59UOV76ri4PFm8FAqFjrpLZFxcqghXkC4uVYQrSBeXKsIVpItLFeEK0sWlinAF6eJSRbiCdHGpIlxBurhUEZoQ4uRmF8LF5UlHCLG62WVwcXG5hf8EHCqhkUAAdQcAAAAASUVORK5CYII="
        },
        "warnings": null,
        "errors": null,
        "service_chain": null
    },
    "response_meta": {
        "service_id": "174f7627-7c82-4e6f-9a9c-74af30f1c29b",
        "version_id": "fe3a3443-3d0e-4baf-8c9c-67b9cc291e18",
        "version": "1.0.0",
        "process_time": 0,
        "call_id": "9584e6b4-e761-4009-9697-0d4409b46682",
        "compiler_type": "Type3",
        "compiler_version": "1.0.0",
        "source_hash": null,
        "engine_id": "02FBE240BC722D92BB1A771AA69EB7D2",
        "correlation_id": null,
        "system": "SPARK",
        "request_timestamp": "2022-05-10T00:58:20.752Z"
    },
    "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/metadata-api.md?ask=<question>
```

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.